KiCad PCB EDA Suite
SCHEMATIC_SETTINGS Class Reference

These settings were stored in SCH_BASE_FRAME previously. More...

#include <schematic_settings.h>

Inheritance diagram for SCHEMATIC_SETTINGS:
NESTED_SETTINGS JSON_SETTINGS

Public Member Functions

 SCHEMATIC_SETTINGS (JSON_SETTINGS *aParent, const std::string &aPath)
 
virtual ~SCHEMATIC_SETTINGS ()
 
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)
 
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 nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
 Sets the given string if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
 Sets the given unsigned int if the given key/path is present. More...
 

Public Attributes

int m_DefaultLineWidth
 
int m_DefaultWireThickness
 
int m_DefaultBusThickness
 
int m_DefaultTextSize
 
double m_TextOffsetRatio
 
int m_PinSymbolSize
 
int m_JunctionSize
 
int m_JunctionSizeChoice
 
bool m_IntersheetRefsShow
 
bool m_IntersheetRefsFormatShort
 
wxString m_IntersheetRefsPrefix
 
wxString m_IntersheetRefsSuffix
 
wxString m_PageLayoutDescrFile
 
wxString m_PlotDirectoryName
 
wxString m_NetFormatName
 
bool m_SpiceAdjustPassiveValues
 
wxString m_SpiceCommandString
 
TEMPLATES m_TemplateFieldNames
 

Protected Member Functions

void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another. More...
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Protected Attributes

JSON_SETTINGSm_parent
 A pointer to the parent object to load and store from. More...
 
std::string m_path
 The path (in pointer format) of where to store this document in the parent. More...
 
wxString m_filename
 The filename (not including path) of this settings file (inicode) More...
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. More...
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 

Detailed Description

These settings were stored in SCH_BASE_FRAME previously.

The backing store is currently the project file. They should likely move to a project settings file (JSON) once that framework exists.

These are loaded from eeschema settings but then overwritten by the project settings. All of the values are stored in IU, but the backing file stores in mils.

Definition at line 36 of file schematic_settings.h.

Constructor & Destructor Documentation

◆ SCHEMATIC_SETTINGS()

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

Definition at line 35 of file schematic_settings.cpp.

35  :
36  NESTED_SETTINGS( "schematic", schSettingsSchemaVersion, aParent, aPath ),
45  m_IntersheetRefsShow( false ),
50 {
51  EESCHEMA_SETTINGS* appSettings = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
52 
53  int defaultLineThickness =
54  appSettings ? appSettings->m_Drawing.default_line_thickness : DEFAULT_LINE_THICKNESS;
55  int defaultWireThickness =
56  appSettings ? appSettings->m_Drawing.default_wire_thickness : DEFAULT_WIRE_THICKNESS;
57  int defaultBusThickness =
58  appSettings ? appSettings->m_Drawing.default_bus_thickness : DEFAULT_BUS_THICKNESS;
59  int defaultTextSize =
60  appSettings ? appSettings->m_Drawing.default_text_size : DEFAULT_TEXT_SIZE;
61  int defaultPinSymbolSize =
62  appSettings ? appSettings->m_Drawing.pin_symbol_size : DEFAULT_TEXT_SIZE / 2;
63  int defaultJunctionSize =
64  appSettings ? appSettings->m_Drawing.default_junction_size : DEFAULT_JUNCTION_DIAM;
65  int defaultJunctionSizeChoice =
66  appSettings ? appSettings->m_Drawing.junction_size_choice : 3;
67  bool defaultIntersheetsRefShow =
68  appSettings ? appSettings->m_Drawing.intersheets_ref_show : false;
69  bool defaultIntersheetsRefFormatShort =
70  appSettings ? appSettings->m_Drawing.intersheets_ref_short : false;
71  wxString defaultIntersheetsRefPrefix =
72  appSettings ? appSettings->m_Drawing.intersheets_ref_prefix : DEFAULT_IREF_PREFIX;
73  wxString defaultIntersheetsRefSuffix =
74  appSettings ? appSettings->m_Drawing.intersheets_ref_suffix : DEFAULT_IREF_SUFFIX;
75 
76  m_params.emplace_back( new PARAM<bool>( "drawing.intersheets_ref_show",
77  &m_IntersheetRefsShow, defaultIntersheetsRefShow ) );
78 
79  m_params.emplace_back( new PARAM<bool>( "drawing.intersheets_ref_short",
80  &m_IntersheetRefsFormatShort, defaultIntersheetsRefFormatShort ) );
81 
82  m_params.emplace_back( new PARAM<wxString>( "drawing.intersheets_ref_prefix",
83  &m_IntersheetRefsPrefix, defaultIntersheetsRefPrefix ) );
84 
85  m_params.emplace_back( new PARAM<wxString>( "drawing.intersheets_ref_suffix",
86  &m_IntersheetRefsSuffix, defaultIntersheetsRefSuffix ) );
87 
88  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_line_thickness",
89  &m_DefaultLineWidth, Mils2iu( defaultLineThickness ),
90  Mils2iu( 5 ), Mils2iu( 1000 ), 1 / IU_PER_MILS ) );
91 
92  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_wire_thickness",
93  &m_DefaultWireThickness, Mils2iu( defaultWireThickness ),
94  Mils2iu( 5 ), Mils2iu( 1000 ), 1 / IU_PER_MILS ) );
95 
96  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_bus_thickness",
97  &m_DefaultBusThickness, Mils2iu( defaultBusThickness ),
98  Mils2iu( 5 ), Mils2iu( 1000 ), 1 / IU_PER_MILS ) );
99 
100  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_text_size",
102  Mils2iu( defaultTextSize ), Mils2iu( 5 ), Mils2iu( 1000 ),
103  1 / IU_PER_MILS ) );
104 
105  m_params.emplace_back( new PARAM<double>( "drawing.text_offset_ratio",
107  (double) TXT_MARGIN / DEFAULT_SIZE_TEXT, -200.0, 200.0 ) );
108 
109  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.pin_symbol_size",
111  Mils2iu( defaultPinSymbolSize ), Mils2iu( 5 ), Mils2iu( 1000 ),
112  1 / IU_PER_MILS ) );
113 
114  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_junction_size",
116  Mils2iu( defaultJunctionSize ), Mils2iu( 5 ), Mils2iu( 1000 ), 1 / IU_PER_MILS ) );
117 
118  // User choice for junction dot size ( e.g. none = 0, smallest = 1, small = 2, etc )
119  m_params.emplace_back(new PARAM<int>("drawing.junction_size_choice",
121  defaultJunctionSizeChoice) );
122 
123  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "drawing.field_names",
124  [&]() -> nlohmann::json
125  {
126  nlohmann::json ret = nlohmann::json::array();
127 
128  for( const TEMPLATE_FIELDNAME& field :
130  {
131  ret.push_back( nlohmann::json( {
132  { "name", field.m_Name },
133  { "visible", field.m_Visible },
134  { "url", field.m_URL }
135  } ) );
136  }
137 
138  return ret;
139  },
140  [&]( const nlohmann::json& aJson )
141  {
142  if( !aJson.empty() && aJson.is_array() )
143  {
145 
146  for( const nlohmann::json& entry : aJson )
147  {
148  if( !entry.contains( "name" ) || !entry.contains( "url" )
149  || !entry.contains( "visible" ) )
150  continue;
151 
152  TEMPLATE_FIELDNAME field( entry["name"].get<wxString>() );
153  field.m_URL = entry["url"].get<bool>();
154  field.m_Visible = entry["visible"].get<bool>();
156  }
157  }
158 
159  auto* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
160 
161  if( cfg )
162  {
163  // Read global fieldname templates
164  wxString templateFieldNames = cfg->m_Drawing.field_names;
165 
166  if( !templateFieldNames.IsEmpty() )
167  {
168  TEMPLATE_FIELDNAMES_LEXER field_lexer( TO_UTF8( templateFieldNames ) );
169 
170  try
171  {
172  m_TemplateFieldNames.Parse( &field_lexer, true );
173  }
174  catch( const IO_ERROR& )
175  {
176  }
177  }
178  }
179  }, {} ) );
180 
181  // TOOD(JE) get rid of this static
182  m_params.emplace_back( new PARAM<wxString>( "page_layout_descr_file",
184 
185  m_params.emplace_back( new PARAM<wxString>( "plot_directory",
186  &m_PlotDirectoryName, "" ) );
187 
188  m_params.emplace_back( new PARAM<wxString>( "net_format_name",
189  &m_NetFormatName, "" ) );
190 
191  m_params.emplace_back( new PARAM<bool>( "spice_adjust_passive_values",
192  &m_SpiceAdjustPassiveValues, false ) );
193 
194  m_params.emplace_back( new PARAM<wxString>( "spice_external_command",
195  &m_SpiceCommandString, "spice \"%I\"" ) );
196 
197  // TODO(JE) should we keep these LIB_PART:: things around?
198  m_params.emplace_back( new PARAM<int>( "subpart_id_separator",
199  LIB_PART::SubpartIdSeparatorPtr(), 0, 0, 126 ) );
200 
201  m_params.emplace_back( new PARAM<int>( "subpart_first_id",
202  LIB_PART::SubpartFirstIdPtr(), 'A', '1', 'z' ) );
203 }
#define DEFAULT_SIZE_TEXT
This is the "default-of-the-default" hardcoded text size; individual application define their own def...
Definition: eda_text.h:80
static int * SubpartFirstIdPtr()
Return a reference to m_subpartFirstId, only for read/save setting functions.
Definition: lib_symbol.h:518
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void AddTemplateFieldName(const TEMPLATE_FIELDNAME &aFieldName, bool aGlobal)
Insert or append a wanted symbol field name into the field names template.
void Parse(TEMPLATE_FIELDNAMES_LEXER *in, bool aGlobal)
Fill this object from information in the input stream handled by #TEMPLATE_FIELDNAMES_LEXER.
TEMPLATES m_TemplateFieldNames
#define DEFAULT_JUNCTION_DIAM
The default bus and wire enty size in mils.
void DeleteAllFieldNameTemplates(bool aGlobal)
Delete the entire contents.
nlohmann::json json
Definition: gerbview.cpp:40
static wxString m_PageLayoutDescrFileName
the name of the page layout descr file, or emty to used the default pagelayout
Definition: base_screen.h:89
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
#define DEFAULT_IREF_PREFIX
The intersheets references suffix string.
const int schSettingsSchemaVersion
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition: parameters.h:388
#define DEFAULT_IREF_SUFFIX
Radius of snap "gravity well".
#define DEFAULT_LINE_THICKNESS
The default wire width in mils. (can be changed in preference menu)
#define DEFAULT_BUS_THICKNESS
The default noconnect size in mils.
#define TXT_MARGIN
The default pin len value when creating pins(can be changed in preference menu)
#define DEFAULT_WIRE_THICKNESS
The default bus width in mils. (can be changed in preference menu)
NESTED_SETTINGS(const std::string &aName, int aSchemaVersion, JSON_SETTINGS *aParent, const std::string &aPath)
#define IU_PER_MILS
Definition: plotter.cpp:137
static int * SubpartIdSeparatorPtr()
Return a reference to m_subpartIdSeparator, only for read/save setting functions.
Definition: lib_symbol.h:512
Hold a name of a symbol's field, field value, and default visibility.
#define DEFAULT_TEXT_SIZE
Ratio of the font height to the baseline of the text above the wire.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
const TEMPLATE_FIELDNAMES & GetTemplateFieldNames()
Return a template field name list for read only access.
#define DEFAULT_TEXT_OFFSET_RATIO
The offset of the pin name string from the end of the pin in mils.

References TEMPLATES::AddTemplateFieldName(), DEFAULT_BUS_THICKNESS, EESCHEMA_SETTINGS::DRAWING::default_bus_thickness, DEFAULT_IREF_PREFIX, DEFAULT_IREF_SUFFIX, DEFAULT_JUNCTION_DIAM, EESCHEMA_SETTINGS::DRAWING::default_junction_size, DEFAULT_LINE_THICKNESS, EESCHEMA_SETTINGS::DRAWING::default_line_thickness, DEFAULT_SIZE_TEXT, DEFAULT_TEXT_SIZE, EESCHEMA_SETTINGS::DRAWING::default_text_size, DEFAULT_WIRE_THICKNESS, EESCHEMA_SETTINGS::DRAWING::default_wire_thickness, TEMPLATES::DeleteAllFieldNameTemplates(), TEMPLATES::GetTemplateFieldNames(), EESCHEMA_SETTINGS::DRAWING::intersheets_ref_prefix, EESCHEMA_SETTINGS::DRAWING::intersheets_ref_short, EESCHEMA_SETTINGS::DRAWING::intersheets_ref_show, EESCHEMA_SETTINGS::DRAWING::intersheets_ref_suffix, IU_PER_MILS, EESCHEMA_SETTINGS::DRAWING::junction_size_choice, Kiface(), m_DefaultBusThickness, m_DefaultLineWidth, m_DefaultTextSize, m_DefaultWireThickness, EESCHEMA_SETTINGS::m_Drawing, m_IntersheetRefsFormatShort, m_IntersheetRefsPrefix, m_IntersheetRefsShow, m_IntersheetRefsSuffix, m_JunctionSize, m_JunctionSizeChoice, m_NetFormatName, BASE_SCREEN::m_PageLayoutDescrFileName, JSON_SETTINGS::m_params, m_PinSymbolSize, m_PlotDirectoryName, m_SpiceAdjustPassiveValues, m_SpiceCommandString, m_TemplateFieldNames, m_TextOffsetRatio, TEMPLATE_FIELDNAME::m_URL, TEMPLATE_FIELDNAME::m_Visible, TEMPLATES::Parse(), EESCHEMA_SETTINGS::DRAWING::pin_symbol_size, LIB_PART::SubpartFirstIdPtr(), LIB_PART::SubpartIdSeparatorPtr(), TO_UTF8, and TXT_MARGIN.

◆ ~SCHEMATIC_SETTINGS()

SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS ( )
virtual

Definition at line 206 of file schematic_settings.cpp.

207 {
208  if( m_parent )
209  {
211  m_parent = nullptr;
212  }
213 }
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 675 of file json_settings.cpp.

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

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

◆ fromLegacy()

template<typename ValueType >
template bool JSON_SETTINGS::fromLegacy< bool > ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig value to a given JSON pointer value.

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

Definition at line 587 of file json_settings.cpp.

589 {
590  ValueType val;
591 
592  if( aConfig->Read( aKey, &val ) )
593  {
594  try
595  {
596  ( *this )[PointerFromString( aDest )] = val;
597  }
598  catch( ... )
599  {
600  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
601  return false;
602  }
603 
604  return true;
605  }
606 
607  return false;
608 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ fromLegacyColor()

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

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

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

Definition at line 647 of file json_settings.cpp.

649 {
650  wxString str;
651 
652  if( aConfig->Read( aKey, &str ) )
653  {
655  color.SetFromWxString( str );
656 
657  try
658  {
659  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
660  ( *this )[PointerFromString( aDest )] = js;
661  }
662  catch( ... )
663  {
664  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
665  return false;
666  }
667 
668  return true;
669  }
670 
671  return false;
672 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

Translates a legacy wxConfig string value to a given JSON pointer value.

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

Definition at line 623 of file json_settings.cpp.

625 {
626  wxString str;
627 
628  if( aConfig->Read( aKey, &str ) )
629  {
630  try
631  {
632  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
633  }
634  catch( ... )
635  {
636  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
637  return false;
638  }
639 
640  return true;
641  }
642 
643  return false;
644 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

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

Fetches a value from within the JSON document.

Will return an empty optional if the value is not found or a mismatching type.

Template Parameters
ValueTypeis the type to cast to
Parameters
aPathis the path within the document to retrieve
Returns
a value from within this document

Definition at line 131 of file json_settings.h.

132  {
133  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
134  {
135  try
136  {
137  return ret->get<ValueType>();
138  }
139  catch( ... )
140  {
141  }
142  }
143 
144  return NULLOPT;
145  }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

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

◆ Get() [2/2]

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

Definition at line 705 of file json_settings.cpp.

706 {
707  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
708  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
709 
710  return NULLOPT;
711 }
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 281 of file json_settings.h.

282  {
283  return wxT( "json" );
284  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 81 of file json_settings.cpp.

82 {
83  return wxString( m_filename + "." + getFileExt() );
84 }
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 436 of file json_settings.cpp.

437 {
438  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
439 
440  if( contains( ptr ) )
441  {
442  try
443  {
444  return OPT<nlohmann::json>{ at( ptr ) };
445  }
446  catch( ... )
447  {
448  }
449  }
450 
451  return OPT<nlohmann::json>{};
452 }
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

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

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 286 of file json_settings.h.

287  {
288  return wxEmptyString;
289  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 70 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetParent()

JSON_SETTINGS* NESTED_SETTINGS::GetParent ( void  )
inlineinherited

Definition at line 54 of file nested_settings.h.

55  {
56  return m_parent;
57  }
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.

References NESTED_SETTINGS::m_parent.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().

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

325 {
326  for( const PARAM_BASE* param : m_params )
327  {
328  if( param->GetJsonPath() == aParamName )
329  return param->IsDefault();
330  }
331 
332  return false;
333 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 87 of file json_settings.cpp.

88 {
89  for( auto param : m_params )
90  {
91  try
92  {
93  param->Load( this, m_resetParamsIfMissing );
94  }
95  catch( ... )
96  {
97  // Skip unreadable parameters in file
98  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
99  }
100  }
101 }
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 41 of file nested_settings.cpp.

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

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

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

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Definition at line 464 of file json_settings.cpp.

465 {
466  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
467 
468  while( filever < m_schemaVersion )
469  {
470  if( !m_migrators.count( filever ) )
471  {
472  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
473  typeid( *this ).name(), filever );
474  return false;
475  }
476 
477  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
478 
479  if( pair.second() )
480  {
481  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
482  filever, pair.first );
483  filever = pair.first;
484  ( *this )[PointerFromString( "meta.version" )] = filever;
485  }
486  else
487  {
488  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
489  typeid( *this ).name(), filever, pair.first );
490  return false;
491  }
492  }
493 
494  return true;
495 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

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

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

◆ MigrateFromLegacy()

bool JSON_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
virtualinherited

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

Reimplemented in PCBNEW_SETTINGS, EESCHEMA_SETTINGS, APP_SETTINGS_BASE, PCB_CALCULATOR_SETTINGS, COMMON_SETTINGS, EDA_3D_VIEWER_SETTINGS, PROJECT_FILE, COLOR_SETTINGS, PROJECT_LOCAL_SETTINGS, SYMBOL_EDITOR_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, CVPCB_SETTINGS, BITMAP2CMP_SETTINGS, PL_EDITOR_SETTINGS, and KICAD_SETTINGS.

Definition at line 498 of file json_settings.cpp.

499 {
500  wxLogTrace( traceSettings,
501  "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
502  return false;
503 }
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ PointerFromString()

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

Builds a JSON pointer based on a given string.

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

Definition at line 506 of file json_settings.cpp.

507 {
508  std::replace( aPath.begin(), aPath.end(), '.', '/' );
509  aPath.insert( 0, "/" );
510 
511  nlohmann::json::json_pointer p;
512 
513  try
514  {
515  p = nlohmann::json::json_pointer( aPath );
516  }
517  catch( ... )
518  {
519  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
520  }
521 
522  return p;
523 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), EESCHEMA_SETTINGS::migrateBomSettings(), 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(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), JSON_SETTINGS::Set(), and JSON_SETTINGS::SetIfPresent().

◆ registerMigration()

void JSON_SETTINGS::registerMigration ( int  aOldSchemaVersion,
int  aNewSchemaVersion,
std::function< bool(void)>  aMigrator 
)
protectedinherited

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 455 of file json_settings.cpp.

457 {
458  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
459  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
460  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
461 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
int m_schemaVersion
Version of this settings schema.

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 682 of file json_settings.cpp.

683 {
684  if( !aSettings )
685  return;
686 
687  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
688  [&aSettings]( const JSON_SETTINGS* aPtr ) {
689  return aPtr == aSettings;
690  } );
691 
692  if( it != m_nested_settings.end() )
693  {
694  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
695  ( *it )->SaveToFile();
696  m_nested_settings.erase( it );
697  }
698 
699  aSettings->SetParent( nullptr );
700 }
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::ClearProject(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and ~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 317 of file json_settings.cpp.

318 {
319  for( auto param : m_params )
320  param->SetDefault();
321 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().

◆ SaveToFile()

bool NESTED_SETTINGS::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
overridevirtualinherited

Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS.

Parameters
aDirectoryis ignored
Returns
true if the document contents were updated

Reimplemented from JSON_SETTINGS.

Definition at line 112 of file nested_settings.cpp.

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

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

◆ Set() [1/3]

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

Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

Template Parameters
ValueTypeis the type to store
Parameters
aPathis a path to store in the form "key1.key2.key3"
aValis the value to store

Definition at line 155 of file json_settings.h.

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

References JSON_SETTINGS::PointerFromString().

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

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 714 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetFilename()

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

Definition at line 68 of file json_settings.h.

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

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 526 of file json_settings.cpp.

528 {
529  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
530 
531  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
532  {
533  aTarget = aObj.at( ptr ).get<wxString>();
534  return true;
535  }
536 
537  return false;
538 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ SetIfPresent() [2/4]

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

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

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

Definition at line 541 of file json_settings.cpp.

543 {
544  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
545 
546  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
547  {
548  aTarget = aObj.at( ptr ).get<bool>();
549  return true;
550  }
551 
552  return false;
553 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

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

Definition at line 556 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

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

Definition at line 571 of file json_settings.cpp.

573 {
574  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
575 
576  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
577  {
578  aTarget = aObj.at( ptr ).get<unsigned int>();
579  return true;
580  }
581 
582  return false;
583 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 72 of file json_settings.h.

72 { m_legacy_filename = aFilename; }
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 195 of file json_settings.h.

196  {
197  m_manager = aManager;
198  }
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 150 of file nested_settings.cpp.

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

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

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

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

Definition at line 75 of file json_settings.h.

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

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

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

304 {
305  bool modified = false;
306 
307  for( auto param : m_params )
308  {
309  modified |= !param->MatchesFile( this );
310  param->Store( this );
311  }
312 
313  return modified;
314 }
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 313 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 307 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_DefaultBusThickness

int SCHEMATIC_SETTINGS::m_DefaultBusThickness

◆ m_DefaultLineWidth

◆ m_DefaultTextSize

◆ m_DefaultWireThickness

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 319 of file json_settings.h.

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

◆ m_filename

◆ m_IntersheetRefsFormatShort

◆ m_IntersheetRefsPrefix

◆ m_IntersheetRefsShow

◆ m_IntersheetRefsSuffix

◆ m_JunctionSize

◆ m_JunctionSizeChoice

int SCHEMATIC_SETTINGS::m_JunctionSizeChoice

◆ 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 295 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 298 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 328 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 334 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 304 of file json_settings.h.

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

◆ m_NetFormatName

wxString SCHEMATIC_SETTINGS::m_NetFormatName

◆ m_PageLayoutDescrFile

wxString SCHEMATIC_SETTINGS::m_PageLayoutDescrFile

Definition at line 60 of file schematic_settings.h.

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

◆ m_PlotDirectoryName

wxString SCHEMATIC_SETTINGS::m_PlotDirectoryName

◆ m_preserved_paths

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

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

Definition at line 331 of file json_settings.h.

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

Whether or not to set parameters to their default value if missing from JSON on Load()

Definition at line 322 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_SpiceAdjustPassiveValues

bool SCHEMATIC_SETTINGS::m_SpiceAdjustPassiveValues

◆ m_SpiceCommandString

wxString SCHEMATIC_SETTINGS::m_SpiceCommandString

◆ m_TemplateFieldNames

◆ m_TextOffsetRatio

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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