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 ()
 
const wxString & GetNetclassName (const wxString &aNetName) const
 
void RebuildNetClassAssignments ()
 Rebuild netclass assignments from the netclass membership lists. More...
 
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)
 
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
 
size_t Count (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...
 
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 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

NETCLASSES m_NetClasses
 
std::map< wxString, wxString > m_NetClassAssignments
 
std::map< wxString, KIGFX::COLOR4Dm_PcbNetColors
 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
 

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

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 32 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  m_NetClasses()
60 {
61  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "classes",
62  [&]() -> nlohmann::json
63  {
64  nlohmann::json ret = nlohmann::json::array();
65 
66  NETCLASSPTR nc = m_NetClasses.GetDefault();
68 
69  for( unsigned int idx = 0; idx <= m_NetClasses.GetCount(); idx++ )
70  {
71  if( idx > 0 )
72  {
73  nc = nc_ii->second;
74  ++nc_ii;
75  }
76 
77  // Note: we're in common/, but we do happen to know which of these fields
78  // are used in which units system.
79  nlohmann::json nc_json = {
80  { "name", nc->GetName().ToUTF8() },
81  { "wire_width", SchIu2Mils( nc->GetWireWidth() ) },
82  { "bus_width", SchIu2Mils( nc->GetBusWidth() ) },
83  { "line_style", nc->GetLineStyle() },
84  { "schematic_color", nc->GetSchematicColor() },
85  { "pcb_color", nc->GetPcbColor() }
86  };
87 
88  auto saveInPcbUnits =
89  []( nlohmann::json& json, const std::string& aKey, int aValue )
90  {
91  json.push_back( { aKey, PcbIu2mm( aValue ) } );
92  };
93 
94  if( nc->HasClearance() )
95  saveInPcbUnits( nc_json, "clearance", nc->GetClearance() );
96 
97  if( nc->HasTrackWidth() )
98  saveInPcbUnits( nc_json, "track_width", nc->GetTrackWidth() );
99 
100  if( nc->HasViaDiameter() )
101  saveInPcbUnits( nc_json, "via_diameter", nc->GetViaDiameter() );
102 
103  if( nc->HasViaDrill() )
104  saveInPcbUnits( nc_json, "via_drill", nc->GetViaDrill() );
105 
106  if( nc->HasuViaDiameter() )
107  saveInPcbUnits( nc_json, "microvia_diameter", nc->GetuViaDiameter() );
108 
109  if( nc->HasuViaDrill() )
110  saveInPcbUnits( nc_json, "microvia_drill", nc->GetuViaDrill() );
111 
112  if( nc->HasDiffPairWidth() )
113  saveInPcbUnits( nc_json, "diff_pair_width", nc->GetDiffPairWidth() );
114 
115  if( nc->HasDiffPairGap() )
116  saveInPcbUnits( nc_json, "diff_pair_gap", nc->GetDiffPairGap() );
117 
118  if( nc->HasDiffPairViaGap() )
119  saveInPcbUnits( nc_json, "diff_pair_via_gap", nc->GetDiffPairViaGap() );
120 
121  if( idx > 0 ) // No need to store members of Default nc
122  {
123  nlohmann::json membersJson = nlohmann::json::array();
124 
125  for( const wxString& member : *nc )
126  {
127  if( !member.empty() )
128  membersJson.push_back( member );
129  }
130 
131  nc_json["nets"] = membersJson;
132  }
133 
134  ret.push_back( nc_json );
135  }
136 
137  return ret;
138  },
139  [&]( const nlohmann::json& aJson )
140  {
141  if( !aJson.is_array() )
142  return;
143 
145  m_NetClassAssignments.clear();
146  NETCLASSPTR nc;
147  NETCLASSPTR defaultClass = m_NetClasses.GetDefault();
148 
149  for( const nlohmann::json& entry : aJson )
150  {
151  if( !entry.is_object() || !entry.contains( "name" ) )
152  continue;
153 
154  wxString name = entry["name"];
155 
156  if( name == defaultClass->GetName() )
157  nc = defaultClass;
158  else
159  nc = std::make_shared<NETCLASS>( name );
160 
161  if( auto value = getInPcbUnits( entry, "clearance" ) )
162  nc->SetClearance( *value );
163 
164  if( auto value = getInPcbUnits( entry, "track_width" ) )
165  nc->SetTrackWidth( *value );
166 
167  if( auto value = getInPcbUnits( entry, "via_diameter" ) )
168  nc->SetViaDiameter( *value );
169 
170  if( auto value = getInPcbUnits( entry, "via_drill" ) )
171  nc->SetViaDrill( *value );
172 
173  if( auto value = getInPcbUnits( entry, "microvia_diameter" ) )
174  nc->SetuViaDiameter( *value );
175 
176  if( auto value = getInPcbUnits( entry, "microvia_drill" ) )
177  nc->SetuViaDrill( *value );
178 
179  if( auto value = getInPcbUnits( entry, "diff_pair_width" ) )
180  nc->SetDiffPairWidth( *value );
181 
182  if( auto value = getInPcbUnits( entry, "diff_pair_gap" ) )
183  nc->SetDiffPairGap( *value );
184 
185  if( auto value = getInPcbUnits( entry, "diff_pair_via_gap" ) )
186  nc->SetDiffPairViaGap( *value );
187 
188  nc->SetWireWidth( getInSchUnits( entry, "wire_width", nc->GetWireWidth() ) );
189  nc->SetBusWidth( getInSchUnits( entry, "bus_width", nc->GetBusWidth() ) );
190 
191  if( entry.contains( "line_style" ) && entry["line_style"].is_number() )
192  nc->SetLineStyle( entry["line_style"].get<int>() );
193 
194  if( entry.contains( "nets" ) && entry["nets"].is_array() )
195  {
196  for( const auto& net : entry["nets"].items() )
197  {
198  wxString netname = net.value().get<wxString>();
199 
200  if( m_schemaVersion < 2 )
201  {
202  // Strip out buses from older 5.99 implementations. They were
203  // a world of hurt, never fully functional, and are functionally
204  // replaced by assigning a netclass to a bus on the canvas.
205  wxString unescaped = UnescapeString( netname );
206  wxString prefix;
207  std::vector<wxString> members;
208 
209  if( ParseBusVector( unescaped, &prefix, &members ) )
210  continue;
211  else if( ParseBusGroup( unescaped, &prefix, &members ) )
212  continue;
213  }
214 
215  nc->Add( netname );
216  }
217  }
218 
219  if( entry.contains( "pcb_color" ) && entry["pcb_color"].is_string() )
220  nc->SetPcbColor( entry["pcb_color"].get<KIGFX::COLOR4D>() );
221 
222  if( entry.contains( "schematic_color" )
223  && entry["schematic_color"].is_string() )
224  {
225  nc->SetSchematicColor( entry["schematic_color"].get<KIGFX::COLOR4D>() );
226  }
227 
228  if( nc != defaultClass )
229  m_NetClasses.Add( nc );
230 
231  for( const wxString& net : *nc )
232  m_NetClassAssignments[ net ] = nc->GetName();
233  }
234  },
235  {} ) );
236 
237  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "net_colors",
238  [&]() -> nlohmann::json
239  {
240  nlohmann::json ret = {};
241 
242  for( const auto& pair : m_PcbNetColors )
243  {
244  std::string key( pair.first.ToUTF8() );
245  ret[key] = pair.second;
246  }
247 
248  return ret;
249  },
250  [&]( const nlohmann::json& aJson )
251  {
252  if( !aJson.is_object() )
253  return;
254 
255  m_PcbNetColors.clear();
256 
257  for( const auto& pair : aJson.items() )
258  {
259  wxString key( pair.key().c_str(), wxConvUTF8 );
260  m_PcbNetColors[key] = pair.value().get<KIGFX::COLOR4D>();
261  }
262  },
263  {} ) );
264 
265  registerMigration( 0, 1, std::bind( &NET_SETTINGS::migrateSchema0to1, this ) );
266 }
static int getInSchUnits(const nlohmann::json &aObj, const std::string &aKey, int aDefault)
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:44
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
std::map< wxString, KIGFX::COLOR4D > m_PcbNetColors
A map of fully-qualified net names to colors used in the board context.
Definition: net_settings.h:52
constexpr double PcbIu2mm(int iu)
nlohmann::json json
Definition: gerbview.cpp:41
NETCLASS_MAP::const_iterator const_iterator
Definition: netclass.h:238
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.
iterator begin()
Definition: netclass.h:235
NETCLASSES m_NetClasses
Definition: net_settings.h:40
constexpr double SchIu2Mils(int iu)
wxString UnescapeString(const wxString &aSource)
bool Add(const NETCLASSPTR &aNetclass)
Add aNetclass and puts it into this NETCLASSES container.
Definition: netclass.cpp:90
void Clear()
Destroy any contained NETCLASS instances except the default one, and clears any members from the defa...
Definition: netclass.h:228
const char * name
Definition: DXF_plotter.cpp:56
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
static bool ParseBusVector(const wxString &aBus, wxString *aName, std::vector< wxString > *aMemberList)
Parse a bus vector (e.g.
NESTED_SETTINGS(const std::string &aName, int aSchemaVersion, JSON_SETTINGS *aParent, const std::string &aPath)
unsigned GetCount() const
Definition: netclass.h:245
NETCLASSPTR GetDefault() const
Definition: netclass.h:253
static OPT< int > getInPcbUnits(const nlohmann::json &aObj, const std::string &aKey, OPT< int > aDefault=OPT< int >())
bool migrateSchema0to1()
const int netSettingsSchemaVersion
int m_schemaVersion
Version of this settings schema.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References NETCLASSES::Add(), NETCLASSES::begin(), NETCLASSES::Clear(), NETCLASSES::GetCount(), NETCLASSES::GetDefault(), getInPcbUnits(), getInSchUnits(), m_NetClassAssignments, m_NetClasses, JSON_SETTINGS::m_params, m_PcbNetColors, JSON_SETTINGS::m_schemaVersion, migrateSchema0to1(), name, ParseBusGroup(), ParseBusVector(), PcbIu2mm(), JSON_SETTINGS::registerMigration(), SchIu2Mils(), and UnescapeString().

◆ ~NET_SETTINGS()

NET_SETTINGS::~NET_SETTINGS ( )
virtual

Definition at line 269 of file net_settings.cpp.

270 {
271  // Release early before destroying members
272  if( m_parent )
273  {
275  m_parent = nullptr;
276  }
277 }
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 743 of file json_settings.cpp.

744 {
745  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
746  m_nested_settings.push_back( aSettings );
747 }
wxString GetFilename() const
Definition: json_settings.h:72
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().

◆ 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 BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

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

Definition at line 117 of file json_settings.cpp.

118 {
119  return m_internals->contains( JSON_SETTINGS_INTERNALS::PointerFromString( aPath ) );
120 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SETTINGS_MANAGER::SaveColorSettings().

◆ Count()

size_t JSON_SETTINGS::Count ( const std::string &  aPath) const
inherited

Definition at line 123 of file json_settings.cpp.

124 {
126 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1().

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

657 {
658  ValueType val;
659 
660  if( aConfig->Read( aKey, &val ) )
661  {
662  try
663  {
664  ( *m_internals )[aDest] = val;
665  }
666  catch( ... )
667  {
668  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
669  return false;
670  }
671 
672  return true;
673  }
674 
675  return false;
676 }

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

717 {
718  wxString str;
719 
720  if( aConfig->Read( aKey, &str ) )
721  {
723  color.SetFromWxString( str );
724 
725  try
726  {
727  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
728  ( *m_internals )[aDest] = js;
729  }
730  catch( ... )
731  {
732  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
733  return false;
734  }
735 
736  return true;
737  }
738 
739  return false;
740 }
int color
Definition: DXF_plotter.cpp:57
nlohmann::json json
Definition: gerbview.cpp:41
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

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

693 {
694  wxString str;
695 
696  if( aConfig->Read( aKey, &str ) )
697  {
698  try
699  {
700  ( *m_internals )[aDest] = str.ToUTF8();
701  }
702  catch( ... )
703  {
704  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
705  return false;
706  }
707 
708  return true;
709  }
710 
711  return false;
712 }

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

◆ Get() [1/2]

template<typename ValueType >
template OPT< 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 494 of file json_settings.cpp.

495 {
496  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
497  {
498  try
499  {
500  return ret->get<ValueType>();
501  }
502  catch( ... )
503  {
504  }
505  }
506 
507  return NULLOPT;
508 }
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(), 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 773 of file json_settings.cpp.

774 {
775  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
776  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
777 
778  return NULLOPT;
779 }
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 269 of file json_settings.h.

270  {
271  return wxT( "json" );
272  }

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

475 {
476  nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
477 
478  if( m_internals->contains( ptr ) )
479  {
480  try
481  {
482  return OPT<nlohmann::json>{ m_internals->at( ptr ) };
483  }
484  catch( ... )
485  {
486  }
487  }
488 
489  return OPT<nlohmann::json>{};
490 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::m_internals.

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(), 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 274 of file json_settings.h.

275  {
276  return wxEmptyString;
277  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 78 of file json_settings.h.

78 { return m_location; }
SETTINGS_LOC m_location
The location of this settings file (.

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetNetclassName()

const wxString & NET_SETTINGS::GetNetclassName ( const wxString &  aNetName) const

Definition at line 302 of file net_settings.cpp.

303 {
304  static wxString defaultNetname = NETCLASS::Default;
305 
306  auto it = m_NetClassAssignments.find( aNetName );
307 
308  if( it == m_NetClassAssignments.end() )
309  return defaultNetname;
310  else
311  return it->second;
312 }
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:44
static const char Default[]
the name of the default NETCLASS
Definition: netclass.h:49

References NETCLASS::Default, and m_NetClassAssignments.

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), SCH_ITEM::NetClass(), and BOARD::SynchronizeNetsAndNetClasses().

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

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 129 of file json_settings.cpp.

130 {
131  return m_internals.get();
132 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

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

136 {
137  for( auto param : m_params )
138  {
139  try
140  {
141  param->Load( this, m_resetParamsIfMissing );
142  }
143  catch( ... )
144  {
145  // Skip unreadable parameters in file
146  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
147  }
148  }
149 }
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  m_internals->clear();
45  bool success = false;
46 
47  if( m_parent )
48  {
49  nlohmann::json::json_pointer ptr = m_internals->PointerFromString( m_path );
50 
51  if( m_parent->m_internals->contains( ptr ) )
52  {
53  try
54  {
55  m_internals->update( m_parent->m_internals->at( ptr ) );
56 
57  wxLogTrace( traceSettings, "Loaded NESTED_SETTINGS %s", GetFilename() );
58 
59  success = true;
60  }
61  catch( ... )
62  {
63  wxLogTrace( traceSettings, "NESTED_SETTINGS %s: Could not load from %s at %s",
65  }
66  }
67  }
68 
69  if( success )
70  {
71  int filever = -1;
72 
73  try
74  {
75  filever = m_internals->Get<int>( "meta.version" );
76  }
77  catch( ... )
78  {
79  wxLogTrace( traceSettings, "%s: nested settings version could not be read!",
80  m_filename );
81  success = false;
82  }
83 
84  if( filever >= 0 && filever < m_schemaVersion )
85  {
86  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
87  m_filename, filever, m_schemaVersion );
88 
89  if( !Migrate() )
90  {
91  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
92  success = false;
93  }
94  }
95  else if( filever > m_schemaVersion )
96  {
97  wxLogTrace( traceSettings,
98  "%s: warning: nested settings version %d is newer than latest (%d)",
99  m_filename, filever, m_schemaVersion );
100  }
101  else if( filever >= 0 )
102  {
103  wxLogTrace( traceSettings, "%s: schema version %d is current", m_filename, filever );
104  }
105  }
106 
107  Load();
108 
109  return success;
110 }
wxString GetFilename() const
Definition: json_settings.h:72
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.
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
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.
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 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().

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

553 {
554  int filever = m_internals->Get<int>( "meta.version" );
555 
556  while( filever < m_schemaVersion )
557  {
558  if( !m_migrators.count( filever ) )
559  {
560  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
561  typeid( *this ).name(), filever );
562  return false;
563  }
564 
565  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
566 
567  if( pair.second() )
568  {
569  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
570  filever, pair.first );
571  filever = pair.first;
572  m_internals->At( "meta.version" ) = filever;
573  }
574  else
575  {
576  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
577  typeid( *this ).name(), filever, pair.first );
578  return false;
579  }
580  }
581 
582  return true;
583 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::m_internals, JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, 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, COMMON_SETTINGS, PCB_CALCULATOR_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 586 of file json_settings.cpp.

587 {
588  wxLogTrace( traceSettings,
589  "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
590  return false;
591 }
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ migrateSchema0to1()

bool NET_SETTINGS::migrateSchema0to1 ( )
private

Definition at line 280 of file net_settings.cpp.

281 {
282  if( m_internals->contains( "classes" ) && m_internals->At( "classes" ).is_array() )
283  {
284  for( auto& netClass : m_internals->At( "classes" ).items() )
285  {
286  if( netClass.value().contains( "nets" ) && netClass.value()["nets"].is_array() )
287  {
288  nlohmann::json migrated = nlohmann::json::array();
289 
290  for( auto& net : netClass.value()["nets"].items() )
291  migrated.push_back( ConvertToNewOverbarNotation( net.value().get<wxString>() ) );
292 
293  netClass.value()["nets"] = migrated;
294  }
295  }
296  }
297 
298  return true;
299 }
wxString ConvertToNewOverbarNotation(const wxString &aOldStr)
Convert the old ~...~ overbar notation to the new ~{...} one.
nlohmann::json json
Definition: gerbview.cpp:41
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References ConvertToNewOverbarNotation(), and 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 452 of file net_settings.cpp.

454 {
455  size_t groupLen = aGroup.length();
456  size_t i = 0;
457  wxString prefix;
458  wxString suffix;
459  wxString tmp;
460  int braceNesting = 0;
461 
462  prefix.reserve( groupLen );
463 
464  // Parse prefix
465  //
466  for( ; i < groupLen; ++i )
467  {
468  if( aGroup[i] == '{' )
469  {
470  if( i > 0 && isSuperSubOverbar( aGroup[i-1] ) )
471  braceNesting++;
472  else
473  break;
474  }
475  else if( aGroup[i] == '}' )
476  {
477  braceNesting--;
478  }
479 
480  if( aGroup[i] == ' ' || aGroup[i] == '[' || aGroup[i] == ']' )
481  return false;
482 
483  prefix += aGroup[i];
484  }
485 
486  if( braceNesting != 0 )
487  return false;
488 
489  if( aName )
490  *aName = prefix;
491 
492  // Parse members
493  //
494  i++; // '{' character
495 
496  if( i >= groupLen )
497  return false;
498 
499  for( ; i < groupLen; ++i )
500  {
501  if( aGroup[i] == '{' )
502  {
503  if( i > 0 && isSuperSubOverbar( aGroup[i-1] ) )
504  braceNesting++;
505  else
506  return false;
507  }
508  else if( aGroup[i] == '}' )
509  {
510  if( braceNesting )
511  {
512  braceNesting--;
513  }
514  else
515  {
516  if( aMemberList && !tmp.IsEmpty() )
517  aMemberList->push_back( EscapeString( tmp, CTX_NETNAME ) );
518 
519  return true;
520  }
521  }
522 
523  // Commas aren't strictly legal, but we can be pretty sure what the author had in mind.
524  if( aGroup[i] == ' ' || aGroup[i] == ',' )
525  {
526  if( aMemberList && !tmp.IsEmpty() )
527  aMemberList->push_back( EscapeString( tmp, CTX_NETNAME ) );
528 
529  tmp.Clear();
530  continue;
531  }
532 
533  tmp += aGroup[i];
534  }
535 
536  return false;
537 }
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:...

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

Referenced by SCH_CONNECTION::AppendInfoToMsgPanel(), SCH_CONNECTION::ConfigureFromLabel(), SCH_CONNECTION::IsBusLabel(), SCH_NETNAME_VALIDATOR::IsValid(), and NET_SETTINGS().

◆ 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 321 of file net_settings.cpp.

323 {
324  auto isDigit = []( wxChar c )
325  {
326  static wxString digits( wxT( "0123456789" ) );
327  return digits.Contains( c );
328  };
329 
330  size_t busLen = aBus.length();
331  size_t i = 0;
332  wxString prefix;
333  wxString suffix;
334  wxString tmp;
335  long begin = 0;
336  long end = 0;
337  int braceNesting = 0;
338 
339  prefix.reserve( busLen );
340 
341  // Parse prefix
342  //
343  for( ; i < busLen; ++i )
344  {
345  if( aBus[i] == '{' )
346  {
347  if( i > 0 && isSuperSubOverbar( aBus[i-1] ) )
348  braceNesting++;
349  else
350  return false;
351  }
352  else if( aBus[i] == '}' )
353  {
354  braceNesting--;
355  }
356 
357  if( aBus[i] == ' ' || aBus[i] == ']' )
358  return false;
359 
360  if( aBus[i] == '[' )
361  break;
362 
363  prefix += aBus[i];
364  }
365 
366  // Parse start number
367  //
368  i++; // '[' character
369 
370  if( i >= busLen )
371  return false;
372 
373  for( ; i < busLen; ++i )
374  {
375  if( aBus[i] == '.' && i + 1 < busLen && aBus[i+1] == '.' )
376  {
377  tmp.ToLong( &begin );
378  i += 2;
379  break;
380  }
381 
382  if( !isDigit( aBus[i] ) )
383  return false;
384 
385  tmp += aBus[i];
386  }
387 
388  // Parse end number
389  //
390  tmp = wxEmptyString;
391 
392  if( i >= busLen )
393  return false;
394 
395  for( ; i < busLen; ++i )
396  {
397  if( aBus[i] == ']' )
398  {
399  tmp.ToLong( &end );
400  ++i;
401  break;
402  }
403 
404  if( !isDigit( aBus[i] ) )
405  return false;
406 
407  tmp += aBus[i];
408  }
409 
410  // Parse suffix
411  //
412  for( ; i < busLen; ++i )
413  {
414  if( aBus[i] == '}' )
415  {
416  braceNesting--;
417  suffix += aBus[i];
418  }
419  else
420  {
421  return false;
422  }
423  }
424 
425  if( braceNesting != 0 )
426  return false;
427 
428  if( begin == end )
429  return false;
430  else if( begin > end )
431  std::swap( begin, end );
432 
433  if( aName )
434  *aName = prefix;
435 
436  if( aMemberList )
437  {
438  for( long idx = begin; idx <= end; ++idx )
439  {
440  wxString str = prefix;
441  str << idx;
442  str << suffix;
443 
444  aMemberList->emplace_back( str );
445  }
446  }
447 
448  return true;
449 }
bool isDigit(char cc)
Definition: dsnlexer.cpp:454
static bool isSuperSubOverbar(wxChar c)

References isDigit(), and isSuperSubOverbar().

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

◆ RebuildNetClassAssignments()

void NET_SETTINGS::RebuildNetClassAssignments ( )

Rebuild netclass assignments from the netclass membership lists.

Definition at line 540 of file net_settings.cpp.

541 {
542  m_NetClassAssignments.clear();
543 
544  for( const std::pair<const wxString, NETCLASSPTR>& netclass : m_NetClasses )
545  {
546  for( const wxString& net : *netclass.second )
547  m_NetClassAssignments[ net ] = netclass.second->GetName();
548  }
549 }
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:44
NETCLASSES m_NetClasses
Definition: net_settings.h:40

References m_NetClassAssignments, and m_NetClasses.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

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

545 {
546  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
547  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
548  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
549 }
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(), 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(), and SCHEMATIC_SETTINGS::SCHEMATIC_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 750 of file json_settings.cpp.

751 {
752  if( !aSettings )
753  return;
754 
755  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
756  [&aSettings]( const JSON_SETTINGS* aPtr ) {
757  return aPtr == aSettings;
758  } );
759 
760  if( it != m_nested_settings.end() )
761  {
762  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
763  ( *it )->SaveToFile();
764  m_nested_settings.erase( it );
765  }
766 
767  aSettings->SetParent( nullptr );
768 }
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)
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::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 367 of file json_settings.cpp.

368 {
369  for( auto param : m_params )
370  param->SetDefault();
371 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

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 113 of file nested_settings.cpp.

114 {
115  if( !m_parent )
116  return false;
117 
118  try
119  {
120  bool modified = Store();
121 
122  auto jsonObjectInParent = m_parent->GetJson( m_path );
123 
124  if( !jsonObjectInParent )
125  modified = true;
126  else if( !nlohmann::json::diff( *m_internals, jsonObjectInParent.value() ).empty() )
127  modified = true;
128 
129  if( modified || aForce )
130  {
131  ( *m_parent->m_internals )[m_path].update( *m_internals );
132 
133  wxLogTrace( traceSettings, "Stored NESTED_SETTINGS %s with schema %d",
134  GetFilename(),
135  m_schemaVersion );
136  }
137 
138  return modified;
139  }
140  catch( ... )
141  {
142  wxLogTrace( traceSettings, "NESTED_SETTINGS %s: Could not store to %s at %s",
143  m_filename,
145  m_path );
146 
147  return false;
148  }
149 }
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:72
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....
wxString m_filename
The filename (not including path) of this settings file (inicode)
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
static bool empty(const wxTextEntryBase *aCtrl)
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.
int m_schemaVersion
Version of this settings schema.

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

525 {
526  m_internals->SetFromString( aPath, aVal );
527 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), PARAM< wxString >::Store(), COLOR_MAP_PARAM::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 782 of file json_settings.cpp.

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

◆ SetFilename()

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

Definition at line 76 of file json_settings.h.

76 { 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::GetColorSettings(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

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

596 {
597  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
598 
599  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
600  {
601  aTarget = aObj.at( ptr ).get<wxString>();
602  return true;
603  }
604 
605  return false;
606 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::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 609 of file json_settings.cpp.

611 {
612  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
613 
614  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
615  {
616  aTarget = aObj.at( ptr ).get<bool>();
617  return true;
618  }
619 
620  return false;
621 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::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 624 of file json_settings.cpp.

626 {
627  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
628 
629  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
630  {
631  aTarget = aObj.at( ptr ).get<int>();
632  return true;
633  }
634 
635  return false;
636 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::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 639 of file json_settings.cpp.

641 {
642  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
643 
644  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
645  {
646  aTarget = aObj.at( ptr ).get<unsigned int>();
647  return true;
648  }
649 
650  return false;
651 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 80 of file json_settings.h.

80 { 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 190 of file json_settings.h.

191  {
192  m_manager = aManager;
193  }
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,
bool  aLoadFromFile = true 
)
inherited

Definition at line 152 of file nested_settings.cpp.

153 {
154  m_parent = aParent;
155 
156  if( m_parent )
157  {
158  m_parent->AddNestedSettings( this );
159 
160  // In case we were created after the parent's ctor
161  if( aLoadFromFile )
162  LoadFromFile();
163  }
164 }
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(), and JSON_SETTINGS::ReleaseNestedSettings().

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns
true if any part of the JSON document was updated

Definition at line 353 of file json_settings.cpp.

354 {
355  bool modified = false;
356 
357  for( auto param : m_params )
358  {
359  modified |= !param->MatchesFile( this );
360  param->Store( this );
361  }
362 
363  return modified;
364 }
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 301 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 295 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 307 of file json_settings.h.

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

◆ 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 283 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 286 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 316 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 319 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 292 of file json_settings.h.

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

◆ m_NetClassAssignments

◆ m_NetClasses

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

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

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 52 of file net_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), NET_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

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