KiCad PCB EDA Suite
LIBEDIT_SETTINGS Class Reference

#include <libedit_settings.h>

Inheritance diagram for LIBEDIT_SETTINGS:
APP_SETTINGS_BASE JSON_SETTINGS

Classes

struct  DEFAULTS
 
struct  REPEAT
 

Public Member Functions

 LIBEDIT_SETTINGS ()
 
virtual ~LIBEDIT_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
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...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
OPT< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
virtual bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. 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

DEFAULTS m_Defaults
 
REPEAT m_Repeat
 
bool m_ShowPinElectricalType
 
int m_LibWidth
 
wxString m_EditComponentVisibleColumns
 
wxString m_PinTableVisibleColumns
 
bool m_UseEeschemaColorSettings
 
CROSS_PROBING_SETTINGS m_CrossProbing
 
FIND_REPLACE m_FindReplace
 
GRAPHICS m_Graphics
 
COLOR_PICKER m_ColorPicker
 
LIB_TREE m_LibTree
 
PRINTING m_Printing
 
SYSTEM m_System
 
WINDOW_SETTINGS m_Window
 
wxString m_ColorTheme
 Active color theme name. More...
 
int m_appSettingsSchemaVersion
 ! Local schema version for common app settings More...
 

Protected Member Functions

virtual std::string getLegacyFrameName () const override
 
void migrateFindReplace (wxConfigBase *aCfg)
 ! Migrates the find/replace history string lists More...
 
bool migrateWindowConfig (wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
 Migrates legacy window settings into the JSON document. More...
 
void addParamsForWindow (WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
 Adds parameters for the given window object. 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

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

Detailed Description

Definition at line 30 of file libedit_settings.h.

Constructor & Destructor Documentation

◆ LIBEDIT_SETTINGS()

LIBEDIT_SETTINGS::LIBEDIT_SETTINGS ( )

Definition at line 35 of file libedit_settings.cpp.

38 {
39  // Make Coverity happy
41 
42  // Init settings:
43  SetLegacyFilename( "eeschema" );
44 
45  m_params.emplace_back( new PARAM<int>( "defaults.line_width",
47 
48  m_params.emplace_back( new PARAM<int>( "defaults.text_size",
50 
51  m_params.emplace_back( new PARAM<int>( "defaults.pin_length",
53 
54  m_params.emplace_back( new PARAM<int>( "defaults.pin_name_size",
56 
57  m_params.emplace_back( new PARAM<int>( "defaults.pin_num_size",
59 
60  m_params.emplace_back( new PARAM<int>( "repeat.label_delta", &m_Repeat.label_delta, 1 ) );
61 
62  m_params.emplace_back( new PARAM<int>( "repeat.pin_step", &m_Repeat.pin_step, 100 ) );
63 
64  m_params.emplace_back( new PARAM<int>( "repeat.x_step", &m_Repeat.x_step, 0 ) );
65 
66  m_params.emplace_back( new PARAM<int>( "repeat.y_step", &m_Repeat.y_step, 100 ) );
67 
68  m_params.emplace_back( new PARAM<bool>( "show_pin_electrical_type",
69  &m_ShowPinElectricalType, true ) );
70 
71  m_params.emplace_back( new PARAM<int>( "lib_table_width", &m_LibWidth, 250 ) );
72 
73  m_params.emplace_back( new PARAM<wxString>( "edit_component_visible_columns",
74  &m_EditComponentVisibleColumns, "0 1 2 3 4 5 6 7" ) );
75 
76  m_params.emplace_back( new PARAM<wxString>( "pin_table_visible_columns",
77  &m_PinTableVisibleColumns, "0 1 2 3 4 8 9" ) );
78 
79  m_params.emplace_back(
80  new PARAM<bool>( "use_eeschema_color_settings", &m_UseEeschemaColorSettings, true ) );
81 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
const int libeditSchemaVersion
! Update the schema version whenever a migration is required
#define DEFAULT_PIN_LENGTH
The default pin number size when creating pins(can be changed in preference menu)
wxString m_PinTableVisibleColumns
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
wxString m_EditComponentVisibleColumns
#define DEFAULT_PINNUM_SIZE
The default pin name size when creating pins(can be changed in preference menu)
#define DEFAULT_PINNAME_SIZE
The default selection highlight thickness (can be changed in preference menu)
#define DEFAULT_LINE_THICKNESS
The default wire width in mils. (can be changed in preference menu)
#define DEFAULT_TEXT_SIZE
The offset of the pin name string from the end of the pin in mils.
void SetLegacyFilename(const wxString &aFilename)
Definition: json_settings.h:70

References DEFAULT_LINE_THICKNESS, DEFAULT_PIN_LENGTH, DEFAULT_PINNAME_SIZE, DEFAULT_PINNUM_SIZE, DEFAULT_TEXT_SIZE, LIBEDIT_SETTINGS::REPEAT::label_delta, LIBEDIT_SETTINGS::DEFAULTS::line_width, m_Defaults, m_EditComponentVisibleColumns, m_LibWidth, JSON_SETTINGS::m_params, m_PinTableVisibleColumns, m_Repeat, m_ShowPinElectricalType, m_UseEeschemaColorSettings, LIBEDIT_SETTINGS::DEFAULTS::pin_length, LIBEDIT_SETTINGS::DEFAULTS::pin_name_size, LIBEDIT_SETTINGS::DEFAULTS::pin_num_size, LIBEDIT_SETTINGS::REPEAT::pin_step, JSON_SETTINGS::SetLegacyFilename(), LIBEDIT_SETTINGS::DEFAULTS::text_size, LIBEDIT_SETTINGS::REPEAT::x_step, and LIBEDIT_SETTINGS::REPEAT::y_step.

◆ ~LIBEDIT_SETTINGS()

virtual LIBEDIT_SETTINGS::~LIBEDIT_SETTINGS ( )
inlinevirtual

Definition at line 53 of file libedit_settings.h.

53 {}

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

608 {
609  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
610  m_nested_settings.push_back( aSettings );
611 }
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().

◆ addParamsForWindow()

void APP_SETTINGS_BASE::addParamsForWindow ( WINDOW_SETTINGS aWindow,
const std::string &  aJsonPath 
)
protectedinherited

Adds parameters for the given window object.

Parameters
aWindowis the target window settings object
aJsonPathis the path to read parameters from

Definition at line 256 of file app_settings.cpp.

257 {
258  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
259  &aWindow->state.maximized, false ) );
260 
261  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
262  &aWindow->mru_path, "" ) );
263 
264  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->state.size_x, 0 ) );
265 
266  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->state.size_y, 0 ) );
267 
268  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
269  &aWindow->perspective, "" ) );
270 
271  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->state.pos_x, 0 ) );
272 
273  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->state.pos_y, 0 ) );
274 
275  m_params.emplace_back( new PARAM<unsigned int>( aJsonPath + ".display", &aWindow->state.display, 0 ) );
276 
277  m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
278  &aWindow->zoom_factors, {} ) );
279 
280  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
281  &aWindow->grid.axes_enabled, false ) );
282 
283  m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
284  &aWindow->grid.sizes, {} ) );
285 
286  // pcbnew default grid doesn't matter much, but eeschema does, so default to the index
287  // of the 50mil grid in eeschema
288  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
289  &aWindow->grid.last_size_idx, 1 ) );
290 
291  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
292  &aWindow->grid.fast_grid_1, 1 ) );
293 
294  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
295  &aWindow->grid.fast_grid_2, 2 ) );
296 
297  // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
298  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
299  &aWindow->grid.user_grid_x, "10 mil" ) );
300  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
301  &aWindow->grid.user_grid_y, "10 mil" ) );
302 
303  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
304  &aWindow->grid.line_width, 1.0 ) );
305 
306  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
307  &aWindow->grid.min_spacing, 10 ) );
308 
309  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
310  &aWindow->grid.show, true ) );
311 
312  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
313  &aWindow->grid.style, 0 ) );
314 
315  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.snap",
316  &aWindow->grid.snap, 0 ) );
317 
318  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
319  &aWindow->cursor.always_show_cursor, true ) );
320 
321  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
322  &aWindow->cursor.fullscreen_cursor, false ) );
323 }
wxString mru_path
Definition: app_settings.h:84
bool fullscreen_cursor
Definition: app_settings.h:43
wxString user_grid_y
Definition: app_settings.h:54
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
wxString user_grid_x
Definition: app_settings.h:53
double min_spacing
Definition: app_settings.h:59
bool always_show_cursor
Definition: app_settings.h:42
std::vector< double > zoom_factors
Definition: app_settings.h:86
double line_width
Definition: app_settings.h:58
wxString perspective
Definition: app_settings.h:85
std::vector< wxString > sizes
Definition: app_settings.h:52
CURSOR_SETTINGS cursor
Definition: app_settings.h:88
GRID_SETTINGS grid
Definition: app_settings.h:89
WINDOW_STATE state
Definition: app_settings.h:83
unsigned int display
Definition: app_settings.h:75

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, WINDOW_STATE::display, GRID_SETTINGS::fast_grid_1, GRID_SETTINGS::fast_grid_2, CURSOR_SETTINGS::fullscreen_cursor, WINDOW_SETTINGS::grid, GRID_SETTINGS::last_size_idx, GRID_SETTINGS::line_width, JSON_SETTINGS::m_params, WINDOW_STATE::maximized, GRID_SETTINGS::min_spacing, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, GRID_SETTINGS::show, WINDOW_STATE::size_x, WINDOW_STATE::size_y, GRID_SETTINGS::sizes, GRID_SETTINGS::snap, WINDOW_SETTINGS::state, GRID_SETTINGS::style, GRID_SETTINGS::user_grid_x, GRID_SETTINGS::user_grid_y, and WINDOW_SETTINGS::zoom_factors.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), CVPCB_SETTINGS::CVPCB_SETTINGS(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

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

521 {
522  ValueType val;
523 
524  if( aConfig->Read( aKey, &val ) )
525  {
526  try
527  {
528  ( *this )[PointerFromString( aDest )] = val;
529  }
530  catch( ... )
531  {
532  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
533  return false;
534  }
535 
536  return true;
537  }
538 
539  return false;
540 }
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 579 of file json_settings.cpp.

581 {
582  wxString str;
583 
584  if( aConfig->Read( aKey, &str ) )
585  {
587  color.SetFromWxString( str );
588 
589  try
590  {
591  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
592  ( *this )[PointerFromString( aDest )] = js;
593  }
594  catch( ... )
595  {
596  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
597  return false;
598  }
599 
600  return true;
601  }
602 
603  return false;
604 }
int color
Definition: DXF_plotter.cpp:61
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.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

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

557 {
558  wxString str;
559 
560  if( aConfig->Read( aKey, &str ) )
561  {
562  try
563  {
564  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
565  }
566  catch( ... )
567  {
568  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
569  return false;
570  }
571 
572  return true;
573  }
574 
575  return false;
576 }
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(), 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 119 of file json_settings.h.

120  {
121  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
122  {
123  try
124  {
125  return ret->get<ValueType>();
126  }
127  catch( ... )
128  {
129  }
130  }
131 
132  return NULLOPT;
133  }
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< ValueType >::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< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

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

Definition at line 637 of file json_settings.cpp.

638 {
639  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
640  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
641 
642  return NULLOPT;
643 }
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 258 of file json_settings.h.

259  {
260  return wxT( "json" );
261  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 78 of file json_settings.cpp.

79 {
80  return wxString( m_filename + "." + getFileExt() );
81 }
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 404 of file json_settings.cpp.

405 {
406  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
407 
408  if( this->contains( ptr ) )
409  {
410  try
411  {
412  return OPT<nlohmann::json>{ this->at( ptr ) };
413  }
414  catch( ... )
415  {
416  }
417  }
418 
419  return OPT<nlohmann::json>{};
420 }
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 JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::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 263 of file json_settings.h.

264  {
265  return wxEmptyString;
266  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

virtual std::string LIBEDIT_SETTINGS::getLegacyFrameName ( ) const
inlineoverrideprotectedvirtual

Reimplemented from APP_SETTINGS_BASE.

Definition at line 73 of file libedit_settings.h.

73 { return "LibeditFrame"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 68 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 84 of file json_settings.cpp.

85 {
86  for( auto param : m_params )
87  {
88  try
89  {
90  param->Load( this, m_resetParamsIfMissing );
91  }
92  catch( ... )
93  {
94  // Skip unreadable parameters in file
95  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
96  }
97  }
98 }
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 NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const wxString &  aDirectory = "")
virtualinherited

Loads the backing file from disk and then calls Load()

Parameters
aDirectoryis the path to the file
Returns
true if the file was found on disk and loaded or migrated

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 101 of file json_settings.cpp.

102 {
103  // First, load all params to default values
104  clear();
105  Load();
106 
107  bool success = true;
108  bool migrated = false;
109  bool legacy_migrated = false;
110 
111  LOCALE_IO locale;
112 
113  auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
114  // Backup and restore during migration so that the original can be mutated if convenient
115  bool backed_up = false;
116  wxFileName temp;
117 
118  if( aPath.IsDirWritable() )
119  {
120  temp.AssignTempFileName( aPath.GetFullPath() );
121 
122  if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
123  {
124  wxLogTrace( traceSettings, "%s: could not create temp file for migration",
125  GetFullFilename() );
126  }
127  else
128  backed_up = true;
129  }
130 
131  wxConfigBase::DontCreateOnDemand();
132  auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
133 
134  // If migrate fails or is not implemented, fall back to built-in defaults that were
135  // already loaded above
136  if( !MigrateFromLegacy( cfg.get() ) )
137  {
138  wxLogTrace( traceSettings,
139  "%s: migrated; not all settings were found in legacy file",
140  GetFullFilename() );
141  }
142  else
143  {
144  wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
145  }
146 
147  if( backed_up )
148  {
149  cfg.reset();
150 
151  if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
152  {
153  wxLogTrace( traceSettings,
154  "migrate; copy temp file %s to %s failed",
155  temp.GetFullPath(), aPath.GetFullPath() );
156  }
157 
158  if( !wxRemoveFile( temp.GetFullPath() ) )
159  {
160  wxLogTrace( traceSettings,
161  "migrate; failed to remove temp file %s",
162  temp.GetFullPath() );
163  }
164  }
165 
166  // Either way, we want to clean up the old file afterwards
167  legacy_migrated = true;
168  };
169 
170  wxFileName path;
171 
172  if( aDirectory.empty() )
173  {
174  path.Assign( m_filename );
175  path.SetExt( getFileExt() );
176  }
177  else
178  {
179  wxString dir( aDirectory );
180  path.Assign( dir, m_filename, getFileExt() );
181  }
182 
183  if( !path.Exists() )
184  {
185  // Case 1: legacy migration, no .json extension yet
186  path.SetExt( getLegacyFileExt() );
187 
188  if( path.Exists() )
189  {
190  migrateFromLegacy( path );
191  }
192  // Case 2: legacy filename is different from new one
193  else if( !m_legacy_filename.empty() )
194  {
195  path.SetName( m_legacy_filename );
196 
197  if( path.Exists() )
198  migrateFromLegacy( path );
199  }
200  else
201  {
202  success = false;
203  }
204  }
205  else
206  {
207  try
208  {
209  FILE* fp = wxFopen( path.GetFullPath(), wxT( "rt" ) );
210  *static_cast<nlohmann::json*>( this ) = nlohmann::json::parse( fp, nullptr,
211  /* allow_exceptions = */ true,
212  /* ignore_comments = */ true );
213 
214  // If parse succeeds, check if schema migration is required
215  int filever = -1;
216 
217  try
218  {
219  filever = at( PointerFromString( "meta.version" ) ).get<int>();
220  }
221  catch( ... )
222  {
223  wxLogTrace(
224  traceSettings, "%s: file version could not be read!", GetFullFilename() );
225  success = false;
226  }
227 
228  if( filever >= 0 && filever < m_schemaVersion )
229  {
230  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
231  GetFullFilename(), filever, m_schemaVersion );
232 
233  if( Migrate() )
234  {
235  migrated = true;
236  }
237  else
238  {
239  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
240  }
241  }
242  else if( filever > m_schemaVersion )
243  {
244  wxLogTrace( traceSettings,
245  "%s: warning: file version %d is newer than latest (%d)", GetFullFilename(),
246  filever, m_schemaVersion );
247  }
248  }
249  catch( nlohmann::json::parse_error& error )
250  {
251  wxLogTrace( traceSettings, "Json parse error reading %s: %s",
252  path.GetFullPath(), error.what() );
253  wxLogTrace( traceSettings, "Attempting migration in case file is in legacy format" );
254  migrateFromLegacy( path );
255  }
256  }
257 
258  // Now that we have new data in the JSON structure, load the params again
259  Load();
260 
261  // And finally load any nested settings
262  for( auto settings : m_nested_settings )
263  settings->LoadFromFile();
264 
265  wxLogTrace( traceSettings, "Loaded <%s> with schema %d", GetFullFilename(), m_schemaVersion );
266 
267  // If we migrated, clean up the legacy file (with no extension)
268  if( legacy_migrated || migrated )
269  {
270  if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
271  {
272  wxLogTrace( traceSettings, "Warning: could not remove legacy file %s",
273  path.GetFullPath() );
274  }
275 
276  // And write-out immediately so that we don't lose data if the program later crashes.
277  SaveToFile( aDirectory );
278  }
279 
280  return success;
281 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
virtual wxString getLegacyFileExt() const
bool parse(std::istream &aStream, bool aVerbose)
Parse a PCB or footprint file from the given input stream.
wxString GetFullFilename() const
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
wxString m_filename
The filename (not including path) of this settings file (inicode)
virtual bool Migrate()
Migrates the schema of this settings from the version in the file to the latest version.
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)
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.
virtual wxString getFileExt() const
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig)
Migrates from wxConfig to JSON-based configuration.
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::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::SaveToFile(), and traceSettings.

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
virtualinherited

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

Reimplemented in BOARD_DESIGN_SETTINGS, COMMON_SETTINGS, COLOR_SETTINGS, PROJECT_LOCAL_SETTINGS, and FOOTPRINT_EDITOR_SETTINGS.

Definition at line 423 of file json_settings.cpp.

424 {
425  wxLogTrace( traceSettings, "Migrate() not implemented for %s", typeid( *this ).name() );
426  return false;
427 }
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References traceSettings.

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

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 196 of file app_settings.cpp.

197 {
198  const int find_replace_history_size = 10;
199  nlohmann::json find_history = nlohmann::json::array();
200  nlohmann::json replace_history = nlohmann::json::array();
201  wxString tmp, find_key, replace_key;
202 
203  for( int i = 0; i < find_replace_history_size; ++i )
204  {
205  find_key.Printf( "FindStringHistoryList%d", i );
206  replace_key.Printf( "ReplaceStringHistoryList%d", i );
207 
208  if( aCfg->Read( find_key, &tmp ) )
209  find_history.push_back( tmp.ToStdString() );
210 
211  if( aCfg->Read( replace_key, &tmp ) )
212  replace_history.push_back( tmp.ToStdString() );
213  }
214 
215  ( *this )[PointerFromString( "find_replace.find_history" )] = find_history;
216  ( *this )[PointerFromString( "find_replace.replace_history" )] = replace_history;
217 }
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.

References JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool LIBEDIT_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

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 from APP_SETTINGS_BASE.

Definition at line 84 of file libedit_settings.cpp.

85 {
86  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
87 
88  ret &= fromLegacy<int>( aCfg, "DefaultWireWidth", "defaults.line_width" );
89  ret &= fromLegacy<int>( aCfg, "DefaultPinLength", "defaults.pin_length" );
90  ret &= fromLegacy<int>( aCfg, "LibeditPinNameSize", "defaults.pin_name_size" );
91  ret &= fromLegacy<int>( aCfg, "LibeditPinNumSize", "defaults.pin_num_size" );
92 
93  ret &= fromLegacy<int>( aCfg, "LibeditRepeatLabelInc", "repeat.label_delta" );
94  ret &= fromLegacy<int>( aCfg, "LibeditPinRepeatStep", "repeat.pin_step" );
95  ret &= fromLegacy<int>( aCfg, "LibeditRepeatStepX", "repeat.x_step" );
96  ret &= fromLegacy<int>( aCfg, "LibeditRepeatStepY", "repeat.y_step" );
97 
98  ret &= fromLegacy<int>( aCfg, "LibeditLibWidth", "lib_table_width" );
99  ret &= fromLegacy<bool>( aCfg, "LibeditShowPinElectricalType", "show_pin_electrical_type" );
100 
101  ret &= fromLegacyString( aCfg, "LibEditFieldsShownColumns", "edit_component_visible_columns" );
102 
103  ret &= fromLegacyString( aCfg, "PinTableShownColumns", "pin_table_visible_columns" );
104 
105  return ret;
106 }
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.

References JSON_SETTINGS::fromLegacyString(), and APP_SETTINGS_BASE::MigrateFromLegacy().

Referenced by EESCHEMA_SETTINGS::MigrateFromLegacy().

◆ migrateWindowConfig()

bool APP_SETTINGS_BASE::migrateWindowConfig ( wxConfigBase *  aCfg,
const std::string &  aFrameName,
const std::string &  aJsonPath 
)
protectedinherited

Migrates legacy window settings into the JSON document.

Parameters
aCfgis the wxConfig object to read from
aFrameNameis the prefix for window settings in the legacy config file
aJsonPathis the prefix for storing window settings in the JSON file
Returns
true if all settings were migrated

Definition at line 220 of file app_settings.cpp.

222 {
223  bool ret = true;
224 
225  const std::string frameGDO = aFrame + "GalDisplayOptions";
226  const std::string cursorPath = aJsonPath + ".cursor";
227  const std::string gridPath = aJsonPath + ".grid";
228 
229  ret &= fromLegacy<bool>( aCfg, aFrame + "Maximized", aJsonPath + ".maximized" );
230  ret &= fromLegacyString( aCfg, aFrame + "MostRecentlyUsedPath", aJsonPath + ".mru_path" );
231  ret &= fromLegacy<int>( aCfg, aFrame + "Size_x", aJsonPath + ".size_x" );
232  ret &= fromLegacy<int>( aCfg, aFrame + "Size_y", aJsonPath + ".size_y" );
233  ret &= fromLegacyString( aCfg, aFrame + "Perspective", aJsonPath + ".perspective" );
234  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_x", aJsonPath + ".pos_x" );
235  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_y", aJsonPath + ".pos_y" );
236 
237  ret &= fromLegacy<bool>( aCfg, frameGDO + "ForceDisplayCursor", cursorPath + ".always_show_cursor" );
238  ret &= fromLegacy<bool>( aCfg, frameGDO + "CursorFullscreen", cursorPath + ".fullscreen_cursor" );
239 
240  ret &= fromLegacy<int>( aCfg, aFrame + "_LastGridSize", gridPath + ".last_size" );
241 
242  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid1", gridPath + ".fast_grid_1" );
243  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid2", gridPath + ".fast_grid_2" );
244 
245  ret &= fromLegacy<bool>( aCfg, frameGDO + "GridAxesEnabled", gridPath + ".axes_enabled" );
246  ret &= fromLegacy<double>( aCfg, frameGDO + "GridLineWidth", gridPath + ".line_width" );
247  ret &= fromLegacy<double>( aCfg, frameGDO + "GridMaxDensity", gridPath + ".min_spacing" );
248  ret &= fromLegacy<bool>( aCfg, frameGDO + "ShowGrid", gridPath + ".show" );
249  ret &= fromLegacy<int>( aCfg, frameGDO + "GridStyle", gridPath + ".style" );
250  ret &= fromLegacyColor( aCfg, frameGDO + "GridColor", gridPath + ".color" );
251 
252  return ret;
253 }
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
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.

References JSON_SETTINGS::fromLegacyColor(), and JSON_SETTINGS::fromLegacyString().

Referenced by CVPCB_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().

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

439 {
440  std::replace( aPath.begin(), aPath.end(), '.', '/' );
441  aPath.insert( 0, "/" );
442 
443  nlohmann::json::json_pointer p;
444 
445  try
446  {
447  p = nlohmann::json::json_pointer( aPath );
448  }
449  catch( ... )
450  {
451  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
452  }
453 
454  return p;
455 }

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(), FOOTPRINT_EDITOR_SETTINGS::Migrate(), PROJECT_LOCAL_SETTINGS::Migrate(), COLOR_SETTINGS::Migrate(), COMMON_SETTINGS::Migrate(), BOARD_DESIGN_SETTINGS::Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_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().

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

615 {
616  if( !aSettings )
617  return;
618 
619  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
620  [&aSettings]( const JSON_SETTINGS* aPtr ) {
621  return aPtr == aSettings;
622  } );
623 
624  if( it != m_nested_settings.end() )
625  {
626  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
627  ( *it )->SaveToFile();
628  m_nested_settings.erase( it );
629  }
630 
631  aSettings->SetParent( nullptr );
632 }
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.
void SetParent(JSON_SETTINGS *aParent)

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::~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 298 of file json_settings.cpp.

299 {
300  for( auto param : m_params )
301  param->SetDefault();
302 }
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 JSON_SETTINGS::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
virtualinherited
   Calls Store() and then writes the contents of the JSON document to a file
   @param aDirectory is the directory to save to, including trailing separator

c *

Returns
true if the file was saved

Reimplemented in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 305 of file json_settings.cpp.

306 {
307  if( !m_writeFile )
308  return false;
309 
310  // Default PROJECT won't have a filename set
311  if( m_filename.IsEmpty() )
312  return false;
313 
314  wxFileName path;
315 
316  if( aDirectory.empty() )
317  {
318  path.Assign( m_filename );
319  path.SetExt( getFileExt() );
320  }
321  else
322  {
323  wxString dir( aDirectory );
324  path.Assign( dir, m_filename, getFileExt() );
325  }
326 
327  if( !m_createIfMissing && !path.FileExists() )
328  {
329  wxLogTrace( traceSettings,
330  "File for %s doesn't exist and m_createIfMissing == false; not saving",
331  GetFullFilename() );
332  return false;
333  }
334 
335  // Ensure the path exists, and create it if not.
336  if( !path.DirExists() && !path.Mkdir() )
337  {
338  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
339  path.GetPath(), GetFullFilename() );
340  return false;
341  }
342 
343  if( ( path.FileExists() && !path.IsFileWritable() ) ||
344  ( !path.FileExists() && !path.IsDirWritable() ) )
345  {
346  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
347  return false;
348  }
349 
350  bool modified = false;
351 
352  for( auto settings : m_nested_settings )
353  modified |= settings->SaveToFile();
354 
355  modified |= Store();
356 
357  if( !modified && !aForce && path.FileExists() )
358  {
359  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
360  return false;
361  }
362  else if( !modified && !aForce && !m_createIfDefault )
363  {
364  wxLogTrace( traceSettings,
365  "%s contents still default and m_createIfDefault == false; not saving",
366  GetFullFilename() );
367  return false;
368  }
369 
370  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
371 
373  bool success = true;
374 
375  try
376  {
377  std::stringstream buffer;
378  buffer << std::setw( 2 ) << *this << std::endl;
379 
380  wxFile file( path.GetFullPath(), wxFile::write );
381 
382  if( !file.IsOpened() || !file.Write( buffer.str().c_str(), buffer.str().size() ) )
383  {
384  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
385  success = false;
386  }
387  }
388  catch( nlohmann::json::exception& error )
389  {
390  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
391  GetFullFilename(), error.what() );
392  success = false;
393  }
394  catch( ... )
395  {
396  wxLogTrace( traceSettings, "Error: could not save %s." );
397  success = false;
398  }
399 
400  return success;
401 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
wxString m_filename
The filename (not including path) of this settings file (inicode)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
virtual wxString getFileExt() const
bool m_writeFile
Whether or not the backing store file should be written.

References dummy(), JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::m_createIfDefault, JSON_SETTINGS::m_createIfMissing, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Store(), and traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), and PGM_BASE::SetLanguage().

◆ 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 143 of file json_settings.h.

144  {
145  ( *this )[PointerFromString( aPath ) ] = aVal;
146  }
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< ValueType >::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 646 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

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

460 {
461  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
462 
463  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
464  {
465  aTarget = aObj.at( ptr ).get<wxString>();
466  return true;
467  }
468 
469  return false;
470 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by 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 473 of file json_settings.cpp.

475 {
476  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
477 
478  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
479  {
480  aTarget = aObj.at( ptr ).get<bool>();
481  return true;
482  }
483 
484  return false;
485 }
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 488 of file json_settings.cpp.

490 {
491  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
492 
493  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
494  {
495  aTarget = aObj.at( ptr ).get<int>();
496  return true;
497  }
498 
499  return false;
500 }
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 503 of file json_settings.cpp.

505 {
506  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
507 
508  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
509  {
510  aTarget = aObj.at( ptr ).get<unsigned int>();
511  return true;
512  }
513 
514  return false;
515 }
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 70 of file json_settings.h.

70 { 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 LIBEDIT_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 183 of file json_settings.h.

184  {
185  m_manager = aManager;
186  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

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

285 {
286  bool modified = false;
287 
288  for( auto param : m_params )
289  {
290  modified |= !param->MatchesFile( this );
291  param->Store( this );
292  }
293 
294  return modified;
295 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by PANEL_MODEDIT_COLOR_SETTINGS::PANEL_MODEDIT_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::SaveToFile().

Member Data Documentation

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings

Definition at line 177 of file app_settings.h.

◆ m_ColorPicker

◆ m_ColorTheme

◆ 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 290 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 284 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_CrossProbing

◆ m_Defaults

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 296 of file json_settings.h.

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

◆ m_EditComponentVisibleColumns

wxString LIBEDIT_SETTINGS::m_EditComponentVisibleColumns

◆ m_filename

wxString JSON_SETTINGS::m_filename
protectedinherited

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_Graphics

◆ 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 272 of file json_settings.h.

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

◆ m_LibTree

LIB_TREE APP_SETTINGS_BASE::m_LibTree
inherited

◆ m_LibWidth

int LIBEDIT_SETTINGS::m_LibWidth

Definition at line 63 of file libedit_settings.h.

Referenced by LIBEDIT_SETTINGS(), and LIB_EDIT_FRAME::SaveSettings().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 275 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 305 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and JSON_SETTINGS::SetManager().

◆ 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 281 of file json_settings.h.

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

◆ m_params

◆ m_PinTableVisibleColumns

wxString LIBEDIT_SETTINGS::m_PinTableVisibleColumns

◆ 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 308 of file json_settings.h.

◆ m_Printing

◆ m_Repeat

◆ 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 299 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_ShowPinElectricalType

bool LIBEDIT_SETTINGS::m_ShowPinElectricalType

◆ m_System

◆ m_UseEeschemaColorSettings

bool LIBEDIT_SETTINGS::m_UseEeschemaColorSettings

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 293 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().


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