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 ResolveNetClassAssignments (bool aRebuildFromScratch=false)
 Explode the list of netclass assignments to include atomic members of composite labels (buses). 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...
 
bool IsDefault (const std::string &aParamName)
 Checks if the current state of a parameter matches its default value. 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 47 of file net_settings.cpp.

47  :
48  NESTED_SETTINGS( "net_settings", netSettingsSchemaVersion, aParent, aPath ),
49  m_NetClasses()
50 {
51  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "classes",
52  [&]() -> nlohmann::json
53  {
54  nlohmann::json ret = nlohmann::json::array();
55 
56  NETCLASSPTR netclass = m_NetClasses.GetDefault();
58 
59  for( unsigned int idx = 0; idx <= m_NetClasses.GetCount(); idx++ )
60  {
61  if( idx > 0 )
62  {
63  netclass = nc->second;
64  ++nc;
65  }
66 
67  // Note: we're in common/, but we do happen to know which of these fields
68  // are used in which units system.
69  nlohmann::json netclassJson = {
70  { "name", netclass->GetName().ToUTF8() },
71  { "wire_width", SchIu2Mils( netclass->GetWireWidth() ) },
72  { "bus_width", SchIu2Mils( netclass->GetBusWidth() ) },
73  { "line_style", netclass->GetLineStyle() },
74  { "schematic_color", netclass->GetSchematicColor() },
75  { "pcb_color", netclass->GetPcbColor() }
76  };
77 
78 
79  if( netclass->HasClearance() )
80  netclassJson.push_back( { "clearance",
81  PcbIu2Millimeter( netclass->GetClearance() ) } );
82 
83  if( netclass->HasTrackWidth() )
84  netclassJson.push_back( { "track_width",
85  PcbIu2Millimeter( netclass->GetTrackWidth() ) } );
86 
87  if( netclass->HasViaDiameter() )
88  netclassJson.push_back( { "via_diameter",
89  PcbIu2Millimeter( netclass->GetViaDiameter() ) } );
90 
91  if( netclass->HasViaDrill() )
92  netclassJson.push_back( { "via_drill",
93  PcbIu2Millimeter( netclass->GetViaDrill() ) } );
94 
95  if( netclass->HasuViaDiameter() )
96  netclassJson.push_back( { "microvia_diameter",
97  PcbIu2Millimeter( netclass->GetuViaDiameter() ) } );
98 
99  if( netclass->HasuViaDrill() )
100  netclassJson.push_back( { "microvia_drill",
101  PcbIu2Millimeter( netclass->GetuViaDrill() ) } );
102 
103  if( netclass->HasDiffPairWidth() )
104  netclassJson.push_back( { "diff_pair_width",
105  PcbIu2Millimeter( netclass->GetDiffPairWidth() ) } );
106 
107  if( netclass->HasDiffPairGap() )
108  netclassJson.push_back( { "diff_pair_gap",
109  PcbIu2Millimeter( netclass->GetDiffPairGap() ) } );
110 
111  if( netclass->HasDiffPairViaGap() )
112  netclassJson.push_back( { "diff_pair_via_gap",
113  PcbIu2Millimeter( netclass->GetDiffPairViaGap() ) } );
114 
115  if( idx > 0 ) // No need to store members of Default netclass
116  {
117  nlohmann::json membersJson = nlohmann::json::array();
118 
119  for( const wxString& member : *netclass )
120  {
121  if( !member.empty() )
122  membersJson.push_back( member );
123  }
124 
125  netclassJson["nets"] = membersJson;
126  }
127 
128  ret.push_back( netclassJson );
129  }
130 
131  return ret;
132  },
133  [&]( const nlohmann::json& aJson )
134  {
135  if( !aJson.is_array() )
136  return;
137 
139  m_NetClassAssignments.clear();
140  NETCLASSPTR netclass;
141  NETCLASSPTR defaultClass = m_NetClasses.GetDefault();
142 
143  auto getInSchematicUnits =
144  []( const nlohmann::json& aObj, const std::string& aKey, int aDefault )
145  {
146  if( aObj.contains( aKey ) && aObj[aKey].is_number() )
147  return SchMils2iu( aObj[aKey].get<double>() );
148  else
149  return aDefault;
150  };
151 
152  for( const nlohmann::json& entry : aJson )
153  {
154  if( !entry.is_object() || !entry.contains( "name" ) )
155  continue;
156 
157  wxString name = entry["name"];
158 
159  if( name == defaultClass->GetName() )
160  netclass = defaultClass;
161  else
162  netclass = std::make_shared<NETCLASS>( name );
163 
164  if( auto value = getInPcbUnits( entry, "clearance" ) )
165  netclass->SetClearance( *value );
166 
167  if( auto value = getInPcbUnits( entry, "track_width" ) )
168  netclass->SetTrackWidth( *value );
169 
170  if( auto value = getInPcbUnits( entry, "via_diameter" ) )
171  netclass->SetViaDiameter( *value );
172 
173  if( auto value = getInPcbUnits( entry, "via_drill" ) )
174  netclass->SetViaDrill( *value );
175 
176  if( auto value = getInPcbUnits( entry, "microvia_diameter" ) )
177  netclass->SetuViaDiameter( *value );
178 
179  if( auto value = getInPcbUnits( entry, "microvia_drill" ) )
180  netclass->SetuViaDrill( *value );
181 
182  if( auto value = getInPcbUnits( entry, "diff_pair_width" ) )
183  netclass->SetDiffPairWidth( *value );
184 
185  if( auto value = getInPcbUnits( entry, "diff_pair_gap" ) )
186  netclass->SetDiffPairGap( *value );
187 
188  if( auto value = getInPcbUnits( entry, "diff_pair_via_gap" ) )
189  netclass->SetDiffPairViaGap( *value );
190 
191  netclass->SetWireWidth( getInSchematicUnits( entry, "wire_width",
192  netclass->GetWireWidth() ) );
193  netclass->SetBusWidth( getInSchematicUnits( entry, "bus_width",
194  netclass->GetWireWidth() ) );
195 
196  if( entry.contains( "line_style" ) && entry["line_style"].is_number() )
197  netclass->SetLineStyle( entry["line_style"].get<int>() );
198 
199  if( entry.contains( "nets" ) && entry["nets"].is_array() )
200  {
201  for( const auto& net : entry["nets"].items() )
202  netclass->Add( net.value().get<wxString>() );
203  }
204 
205  if( entry.contains( "pcb_color" ) && entry["pcb_color"].is_string() )
206  netclass->SetPcbColor( entry["pcb_color"].get<KIGFX::COLOR4D>() );
207 
208  if( entry.contains( "schematic_color" )
209  && entry["schematic_color"].is_string() )
210  netclass->SetSchematicColor(
211  entry["schematic_color"].get<KIGFX::COLOR4D>() );
212 
213  if( netclass != defaultClass )
214  m_NetClasses.Add( netclass );
215 
216  for( const wxString& net : *netclass )
217  m_NetClassAssignments[ net ] = netclass->GetName();
218  }
219 
221  },
222  {} ) );
223 
224  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "net_colors",
225  [&]() -> nlohmann::json
226  {
227  nlohmann::json ret = {};
228 
229  for( const auto& pair : m_PcbNetColors )
230  {
231  std::string key( pair.first.ToUTF8() );
232  ret[key] = pair.second;
233  }
234 
235  return ret;
236  },
237  [&]( const nlohmann::json& aJson )
238  {
239  if( !aJson.is_object() )
240  return;
241 
242  m_PcbNetColors.clear();
243 
244  for( const auto& pair : aJson.items() )
245  {
246  wxString key( pair.key().c_str(), wxConvUTF8 );
247  m_PcbNetColors[key] = pair.value().get<KIGFX::COLOR4D>();
248  }
249  },
250  {} ) );
251 
252  registerMigration( 0, 1, std::bind( &NET_SETTINGS::migrateSchema0to1, this ) );
253 }
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
nlohmann::json json
Definition: gerbview.cpp:41
NETCLASS_MAP::const_iterator const_iterator
Definition: netclass.h:238
iterator begin()
Definition: netclass.h:235
NETCLASSES m_NetClasses
Definition: net_settings.h:40
void ResolveNetClassAssignments(bool aRebuildFromScratch=false)
Explode the list of netclass assignments to include atomic members of composite labels (buses).
constexpr double SchIu2Mils(int iu)
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:59
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
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 >())
constexpr int SchMils2iu(int mils)
bool migrateSchema0to1()
const int netSettingsSchemaVersion
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(), m_NetClassAssignments, m_NetClasses, JSON_SETTINGS::m_params, m_PcbNetColors, migrateSchema0to1(), name, JSON_SETTINGS::registerMigration(), ResolveNetClassAssignments(), SchIu2Mils(), and SchMils2iu().

◆ ~NET_SETTINGS()

NET_SETTINGS::~NET_SETTINGS ( )
virtual

Definition at line 256 of file net_settings.cpp.

257 {
258  // Release early before destroying members
259  if( m_parent )
260  {
262  m_parent = nullptr;
263  }
264 }
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 753 of file json_settings.cpp.

754 {
755  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
756  m_nested_settings.push_back( aSettings );
757 }
wxString GetFilename() const
Definition: json_settings.h:71
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 110 of file json_settings.cpp.

111 {
112  return m_internals->At( aPath );
113 }
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(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

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

Definition at line 116 of file json_settings.cpp.

117 {
118  return m_internals->contains( JSON_SETTINGS_INTERNALS::PointerFromString( aPath ) );
119 }
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 122 of file json_settings.cpp.

123 {
125 }
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 665 of file json_settings.cpp.

667 {
668  ValueType val;
669 
670  if( aConfig->Read( aKey, &val ) )
671  {
672  try
673  {
674  ( *m_internals )[aDest] = val;
675  }
676  catch( ... )
677  {
678  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
679  return false;
680  }
681 
682  return true;
683  }
684 
685  return false;
686 }

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

727 {
728  wxString str;
729 
730  if( aConfig->Read( aKey, &str ) )
731  {
733  color.SetFromWxString( str );
734 
735  try
736  {
737  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
738  ( *m_internals )[aDest] = js;
739  }
740  catch( ... )
741  {
742  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
743  return false;
744  }
745 
746  return true;
747  }
748 
749  return false;
750 }
int color
Definition: DXF_plotter.cpp:60
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 701 of file json_settings.cpp.

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

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

505 {
506  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
507  {
508  try
509  {
510  return ret->get<ValueType>();
511  }
512  catch( ... )
513  {
514  }
515  }
516 
517  return NULLOPT;
518 }
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 783 of file json_settings.cpp.

784 {
785  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
786  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
787 
788  return NULLOPT;
789 }
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 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 104 of file json_settings.cpp.

105 {
106  return wxString( m_filename + "." + getFileExt() );
107 }
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 484 of file json_settings.cpp.

485 {
486  nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
487 
488  if( m_internals->contains( ptr ) )
489  {
490  try
491  {
492  return OPT<nlohmann::json>{ m_internals->at( ptr ) };
493  }
494  catch( ... )
495  {
496  }
497  }
498 
499  return OPT<nlohmann::json>{};
500 }
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 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 77 of file json_settings.h.

77 { 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 289 of file net_settings.cpp.

290 {
291  static wxString defaultNetname = NETCLASS::Default;
292 
293  auto it = m_NetClassAssignments.find( aNetName );
294 
295  if( it == m_NetClassAssignments.end() )
296  return defaultNetname;
297  else
298  return it->second;
299 }
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 128 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ IsDefault()

bool JSON_SETTINGS::IsDefault ( const std::string &  aParamName)
inherited

Checks if the current state of a parameter matches its default value.

Parameters
aParamNameis the JSON path to the parameter
Returns
true if the given parameter is at its default value

Definition at line 372 of file json_settings.cpp.

373 {
374  for( const PARAM_BASE* param : m_params )
375  {
376  if( param->GetJsonPath() == aParamName )
377  return param->IsDefault();
378  }
379 
380  return false;
381 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

◆ IsReadOnly()

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 134 of file json_settings.cpp.

135 {
136  for( auto param : m_params )
137  {
138  try
139  {
140  param->Load( this, m_resetParamsIfMissing );
141  }
142  catch( ... )
143  {
144  // Skip unreadable parameters in file
145  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
146  }
147  }
148 }
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:71
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 562 of file json_settings.cpp.

563 {
564  int filever = m_internals->Get<int>( "meta.version" );
565 
566  while( filever < m_schemaVersion )
567  {
568  if( !m_migrators.count( filever ) )
569  {
570  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
571  typeid( *this ).name(), filever );
572  return false;
573  }
574 
575  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
576 
577  if( pair.second() )
578  {
579  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
580  filever, pair.first );
581  filever = pair.first;
582  m_internals->At( "meta.version" ) = filever;
583  }
584  else
585  {
586  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
587  typeid( *this ).name(), filever, pair.first );
588  return false;
589  }
590  }
591 
592  return true;
593 }
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 596 of file json_settings.cpp.

597 {
598  wxLogTrace( traceSettings,
599  "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
600  return false;
601 }
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 267 of file net_settings.cpp.

268 {
269  if( m_internals->contains( "classes" ) && m_internals->At( "classes" ).is_array() )
270  {
271  for( auto& netClass : m_internals->At( "classes" ).items() )
272  {
273  if( netClass.value().contains( "nets" ) && netClass.value()["nets"].is_array() )
274  {
275  nlohmann::json migrated = nlohmann::json::array();
276 
277  for( auto& net : netClass.value()["nets"].items() )
278  migrated.push_back( ConvertToNewOverbarNotation( net.value().get<wxString>() ) );
279 
280  netClass.value()["nets"] = migrated;
281  }
282  }
283  }
284 
285  return true;
286 }
nlohmann::json json
Definition: gerbview.cpp:41
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
wxString ConvertToNewOverbarNotation(const wxString &aOldStr)
Convert the old ~...~ overbar notation to the new ~{...} one.
Definition: string.cpp:44

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

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

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

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

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

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

References isDigit(), and isSuperSubOverbar().

Referenced by SCH_CONNECTION::ConfigureFromLabel(), SCH_CONNECTION::IsBusLabel(), SCH_NETNAME_VALIDATOR::IsValid(), ResolveNetClassAssignments(), 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 553 of file json_settings.cpp.

555 {
556  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
557  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
558  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
559 }
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(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Saves and frees a nested settings object, if it exists within this one.

Parameters
aSettingsis a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 760 of file json_settings.cpp.

761 {
762  if( !aSettings )
763  return;
764 
765  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
766  [&aSettings]( const JSON_SETTINGS* aPtr ) {
767  return aPtr == aSettings;
768  } );
769 
770  if( it != m_nested_settings.end() )
771  {
772  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
773  ( *it )->SaveToFile();
774  m_nested_settings.erase( it );
775  }
776 
777  aSettings->SetParent( nullptr );
778 }
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 365 of file json_settings.cpp.

366 {
367  for( auto param : m_params )
368  param->SetDefault();
369 }
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().

◆ ResolveNetClassAssignments()

void NET_SETTINGS::ResolveNetClassAssignments ( bool  aRebuildFromScratch = false)

Explode the list of netclass assignments to include atomic members of composite labels (buses).

Parameters
aRebuildFromScratchindicates the assignments should be rebuilt from the netclass membership lists before resolving.

Definition at line 527 of file net_settings.cpp.

528 {
529  std::map<wxString, wxString> baseList;
530 
531  if( aRebuildFromScratch )
532  {
533  for( const std::pair<const wxString, NETCLASSPTR>& netclass : m_NetClasses )
534  {
535  for( const wxString& net : *netclass.second )
536  baseList[ net ] = netclass.second->GetName();
537  }
538  }
539  else
540  {
541  baseList = m_NetClassAssignments;
542  }
543 
544  m_NetClassAssignments.clear();
545 
546  for( const auto& ii : baseList )
547  {
548  m_NetClassAssignments[ ii.first ] = ii.second;
549 
550  wxString unescaped = UnescapeString( ii.first );
551  wxString prefix;
552  std::vector<wxString> members;
553 
554  if( ParseBusVector( unescaped, &prefix, &members ) )
555  {
556  prefix = wxEmptyString;
557  }
558  else if( ParseBusGroup( unescaped, &prefix, &members ) )
559  {
560  if( !prefix.IsEmpty() )
561  prefix += wxT( "." );
562  }
563 
564  for( wxString& member : members )
565  m_NetClassAssignments[ prefix + member ] = ii.second;
566  }
567 }
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:44
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.
NETCLASSES m_NetClasses
Definition: net_settings.h:40
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:222
static bool ParseBusVector(const wxString &aBus, wxString *aName, std::vector< wxString > *aMemberList)
Parse a bus vector (e.g.

References m_NetClassAssignments, m_NetClasses, ParseBusGroup(), ParseBusVector(), and UnescapeString().

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), SCH_EDIT_FRAME::KiwayMailIn(), NET_SETTINGS(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

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

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

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

◆ SetFilename()

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

Definition at line 75 of file json_settings.h.

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

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs(), 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 604 of file json_settings.cpp.

606 {
607  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
608 
609  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
610  {
611  aTarget = aObj.at( ptr ).get<wxString>();
612  return true;
613  }
614 
615  return false;
616 }
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 619 of file json_settings.cpp.

621 {
622  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
623 
624  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
625  {
626  aTarget = aObj.at( ptr ).get<bool>();
627  return true;
628  }
629 
630  return false;
631 }
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 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_number_integer() )
640  {
641  aTarget = aObj.at( ptr ).get<int>();
642  return true;
643  }
644 
645  return false;
646 }
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 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_number_unsigned() )
655  {
656  aTarget = aObj.at( ptr ).get<unsigned int>();
657  return true;
658  }
659 
660  return false;
661 }
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 79 of file json_settings.h.

79 { 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 196 of file json_settings.h.

197  {
198  m_manager = aManager;
199  }
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

Definition at line 82 of file json_settings.h.

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

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

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

352 {
353  bool modified = false;
354 
355  for( auto param : m_params )
356  {
357  modified |= !param->MatchesFile( this );
358  param->Store( this );
359  }
360 
361  return modified;
362 }
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 307 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 301 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 313 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 289 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 292 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 322 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 325 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 298 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 316 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: