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)
 
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 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
 
int m_AnnotateStartNum
 
bool m_IntersheetRefsShow
 
bool m_IntersheetRefsListOwnPage
 
bool m_IntersheetRefsFormatShort
 
wxString m_IntersheetRefsPrefix
 
wxString m_IntersheetRefsSuffix
 
wxString m_PlotDirectoryName
 
wxString m_NetFormatName
 
bool m_SpiceAdjustPassiveValues
 
wxString m_SpiceCommandString
 
TEMPLATES m_TemplateFieldNames
 
std::shared_ptr< NGSPICE_SIMULATOR_SETTINGSm_NgspiceSimulatorSettings
 Ngspice simulator settings. 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
 

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 38 of file schematic_settings.h.

Constructor & Destructor Documentation

◆ SCHEMATIC_SETTINGS()

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

Definition at line 39 of file schematic_settings.cpp.

39  :
40  NESTED_SETTINGS( "schematic", schSettingsSchemaVersion, aParent, aPath ),
49  m_IntersheetRefsShow( false ),
55  m_NgspiceSimulatorSettings( nullptr ),
57 {
58  EESCHEMA_SETTINGS* appSettings = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
59 
60  int defaultLineThickness =
61  appSettings ? appSettings->m_Drawing.default_line_thickness : DEFAULT_LINE_THICKNESS;
62  int defaultWireThickness =
63  appSettings ? appSettings->m_Drawing.default_wire_thickness : DEFAULT_WIRE_THICKNESS;
64  int defaultBusThickness =
65  appSettings ? appSettings->m_Drawing.default_bus_thickness : DEFAULT_BUS_THICKNESS;
66  int defaultTextSize =
67  appSettings ? appSettings->m_Drawing.default_text_size : DEFAULT_TEXT_SIZE;
68  int defaultPinSymbolSize =
69  appSettings ? appSettings->m_Drawing.pin_symbol_size : DEFAULT_TEXT_SIZE / 2;
70  int defaultJunctionSize =
71  appSettings ? appSettings->m_Drawing.default_junction_size : DEFAULT_JUNCTION_DIAM;
72  int defaultJunctionSizeChoice =
73  appSettings ? appSettings->m_Drawing.junction_size_choice : 3;
74  bool defaultIntersheetsRefShow =
75  appSettings ? appSettings->m_Drawing.intersheets_ref_show : false;
76  bool defaultIntersheetsRefOwnPage =
77  appSettings ? appSettings->m_Drawing.intersheets_ref_own_page : true;
78  bool defaultIntersheetsRefFormatShort =
79  appSettings ? appSettings->m_Drawing.intersheets_ref_short : false;
80  wxString defaultIntersheetsRefPrefix =
81  appSettings ? appSettings->m_Drawing.intersheets_ref_prefix : DEFAULT_IREF_PREFIX;
82  wxString defaultIntersheetsRefSuffix =
83  appSettings ? appSettings->m_Drawing.intersheets_ref_suffix : DEFAULT_IREF_SUFFIX;
84 
85  m_params.emplace_back( new PARAM<bool>( "drawing.intersheets_ref_show",
86  &m_IntersheetRefsShow, defaultIntersheetsRefShow ) );
87 
88  m_params.emplace_back( new PARAM<bool>( "drawing.intersheets_ref_own_page",
89  &m_IntersheetRefsListOwnPage, defaultIntersheetsRefOwnPage ) );
90 
91  m_params.emplace_back( new PARAM<bool>( "drawing.intersheets_ref_short",
92  &m_IntersheetRefsFormatShort, defaultIntersheetsRefFormatShort ) );
93 
94  m_params.emplace_back( new PARAM<wxString>( "drawing.intersheets_ref_prefix",
95  &m_IntersheetRefsPrefix, defaultIntersheetsRefPrefix ) );
96 
97  m_params.emplace_back( new PARAM<wxString>( "drawing.intersheets_ref_suffix",
98  &m_IntersheetRefsSuffix, defaultIntersheetsRefSuffix ) );
99 
100  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_line_thickness",
101  &m_DefaultLineWidth, Mils2iu( defaultLineThickness ),
102  Mils2iu( 5 ), Mils2iu( 1000 ), 1 / IU_PER_MILS ) );
103 
104  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_wire_thickness",
105  &m_DefaultWireThickness, Mils2iu( defaultWireThickness ),
106  Mils2iu( 5 ), Mils2iu( 1000 ), 1 / IU_PER_MILS ) );
107 
108  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_bus_thickness",
109  &m_DefaultBusThickness, Mils2iu( defaultBusThickness ),
110  Mils2iu( 5 ), Mils2iu( 1000 ), 1 / IU_PER_MILS ) );
111 
112  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_text_size",
114  Mils2iu( defaultTextSize ), Mils2iu( 5 ), Mils2iu( 1000 ),
115  1 / IU_PER_MILS ) );
116 
117  m_params.emplace_back( new PARAM<double>( "drawing.text_offset_ratio",
119  (double) TXT_MARGIN / DEFAULT_SIZE_TEXT, -200.0, 200.0 ) );
120 
121  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.pin_symbol_size",
123  Mils2iu( defaultPinSymbolSize ), Mils2iu( 5 ), Mils2iu( 1000 ),
124  1 / IU_PER_MILS ) );
125 
126  m_params.emplace_back( new PARAM_SCALED<int>( "drawing.default_junction_size",
128  Mils2iu( defaultJunctionSize ), Mils2iu( 5 ), Mils2iu( 1000 ), 1 / IU_PER_MILS ) );
129 
130  // User choice for junction dot size ( e.g. none = 0, smallest = 1, small = 2, etc )
131  m_params.emplace_back( new PARAM<int>( "drawing.junction_size_choice",
133  defaultJunctionSizeChoice ) );
134 
135  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "drawing.field_names",
136  [&]() -> nlohmann::json
137  {
138  nlohmann::json ret = nlohmann::json::array();
139 
140  for( const TEMPLATE_FIELDNAME& field :
142  {
143  ret.push_back( nlohmann::json( {
144  { "name", field.m_Name },
145  { "visible", field.m_Visible },
146  { "url", field.m_URL }
147  } ) );
148  }
149 
150  return ret;
151  },
152  [&]( const nlohmann::json& aJson )
153  {
154  if( !aJson.empty() && aJson.is_array() )
155  {
157 
158  for( const nlohmann::json& entry : aJson )
159  {
160  if( !entry.contains( "name" ) || !entry.contains( "url" )
161  || !entry.contains( "visible" ) )
162  continue;
163 
164  TEMPLATE_FIELDNAME field( entry["name"].get<wxString>() );
165  field.m_URL = entry["url"].get<bool>();
166  field.m_Visible = entry["visible"].get<bool>();
168  }
169  }
170 
171  auto* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
172 
173  if( cfg )
174  {
175  // Read global fieldname templates
176  wxString templateFieldNames = cfg->m_Drawing.field_names;
177 
178  if( !templateFieldNames.IsEmpty() )
179  {
180  TEMPLATE_FIELDNAMES_LEXER field_lexer( TO_UTF8( templateFieldNames ) );
181 
182  try
183  {
184  m_TemplateFieldNames.Parse( &field_lexer, true );
185  }
186  catch( const IO_ERROR& )
187  {
188  }
189  }
190  }
191  }, {} ) );
192 
193  // TODO(JE) get rid of this static
194  m_params.emplace_back( new PARAM<wxString>( "page_layout_descr_file",
196 
197  m_params.emplace_back( new PARAM<wxString>( "plot_directory",
198  &m_PlotDirectoryName, "" ) );
199 
200  m_params.emplace_back( new PARAM<wxString>( "net_format_name",
201  &m_NetFormatName, "" ) );
202 
203  m_params.emplace_back( new PARAM<bool>( "spice_adjust_passive_values",
204  &m_SpiceAdjustPassiveValues, false ) );
205 
206  m_params.emplace_back( new PARAM<wxString>( "spice_external_command",
207  &m_SpiceCommandString, "spice \"%I\"" ) );
208 
209  // TODO(JE) should we keep these LIB_SYMBOL:: things around?
210  m_params.emplace_back( new PARAM<int>( "subpart_id_separator",
211  LIB_SYMBOL::SubpartIdSeparatorPtr(), 0, 0, 126 ) );
212 
213  m_params.emplace_back( new PARAM<int>( "subpart_first_id",
214  LIB_SYMBOL::SubpartFirstIdPtr(), 'A', '1', 'z' ) );
215 
216  m_params.emplace_back( new PARAM<int>( "annotate_start_num",
217  &m_AnnotateStartNum, 0 ) );
218 
220  std::make_shared<NGSPICE_SIMULATOR_SETTINGS>( this, "ngspice" );
221 }
#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
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
static int * SubpartFirstIdPtr()
Return a reference to m_subpartFirstId, only for read/save setting functions.
Definition: lib_symbol.h:525
#define DEFAULT_JUNCTION_DIAM
The default bus and wire entry size in mils.
void DeleteAllFieldNameTemplates(bool aGlobal)
Delete the entire contents.
nlohmann::json json
Definition: gerbview.cpp:41
std::shared_ptr< NGSPICE_SIMULATOR_SETTINGS > m_NgspiceSimulatorSettings
Ngspice simulator settings.
#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:354
#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)
static int * SubpartIdSeparatorPtr()
Return a reference to m_subpartIdSeparator, only for read/save setting functions.
Definition: lib_symbol.h:519
static wxString m_DrawingSheetFileName
the name of the drawing sheet file, or empty to use the default drawing sheet
Definition: base_screen.h:85
#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
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_own_page, 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_AnnotateStartNum, m_DefaultBusThickness, m_DefaultLineWidth, m_DefaultTextSize, m_DefaultWireThickness, EESCHEMA_SETTINGS::m_Drawing, BASE_SCREEN::m_DrawingSheetFileName, m_IntersheetRefsFormatShort, m_IntersheetRefsListOwnPage, m_IntersheetRefsPrefix, m_IntersheetRefsShow, m_IntersheetRefsSuffix, m_JunctionSize, m_JunctionSizeChoice, m_NetFormatName, m_NgspiceSimulatorSettings, 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_SYMBOL::SubpartFirstIdPtr(), LIB_SYMBOL::SubpartIdSeparatorPtr(), TO_UTF8, and TXT_MARGIN.

◆ ~SCHEMATIC_SETTINGS()

SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS ( )
virtual

Definition at line 224 of file schematic_settings.cpp.

225 {
228 
229  if( m_parent )
230  {
232  m_parent = nullptr;
233  }
234 }
std::shared_ptr< NGSPICE_SIMULATOR_SETTINGS > m_NgspiceSimulatorSettings
Ngspice simulator settings.
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 m_NgspiceSimulatorSettings, 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().

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

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

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

int SCHEMATIC_SETTINGS::m_AnnotateStartNum

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

int SCHEMATIC_SETTINGS::m_DefaultBusThickness

◆ m_DefaultLineWidth

◆ m_DefaultTextSize

◆ m_DefaultWireThickness

int SCHEMATIC_SETTINGS::m_DefaultWireThickness

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

◆ m_IntersheetRefsListOwnPage

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

wxString SCHEMATIC_SETTINGS::m_NetFormatName
Todo:
These should probably be moved to the "schematic.simulator" path.

Definition at line 66 of file schematic_settings.h.

Referenced by InvokeDialogNetList(), NETLIST_DIALOG::NETLIST_DIALOG(), NETLIST_DIALOG::NetlistUpdateOpt(), and SCHEMATIC_SETTINGS().

◆ m_NgspiceSimulatorSettings

std::shared_ptr<NGSPICE_SIMULATOR_SETTINGS> SCHEMATIC_SETTINGS::m_NgspiceSimulatorSettings

Ngspice simulator settings.

Definition at line 77 of file schematic_settings.h.

Referenced by SCH_EDIT_FRAME::doCloseWindow(), SCHEMATIC_SETTINGS(), and ~SCHEMATIC_SETTINGS().

◆ m_params

◆ m_parent

◆ m_path

std::string NESTED_SETTINGS::m_path
protectedinherited

The path (in pointer format) of where to store this document in the parent.

Definition at line 65 of file nested_settings.h.

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

◆ m_PinSymbolSize

◆ m_PlotDirectoryName

wxString SCHEMATIC_SETTINGS::m_PlotDirectoryName

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