KiCad PCB EDA Suite
APP_SETTINGS_BASE Class Reference

APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application. More...

#include <app_settings.h>

Inheritance diagram for APP_SETTINGS_BASE:
JSON_SETTINGS BITMAP2CMP_SETTINGS CVPCB_SETTINGS EDA_3D_VIEWER_SETTINGS EESCHEMA_SETTINGS FOOTPRINT_EDITOR_SETTINGS GERBVIEW_SETTINGS KICAD_SETTINGS PCB_CALCULATOR_SETTINGS PCBNEW_SETTINGS PL_EDITOR_SETTINGS SYMBOL_EDITOR_SETTINGS

Classes

struct  COLOR_PICKER
 
struct  FIND_REPLACE
 
struct  GRAPHICS
 
struct  LIB_TREE
 
struct  PRINTING
 
struct  SYSTEM
 

Public Member Functions

 APP_SETTINGS_BASE (const std::string &aFilename, int aSchemaVersion)
 
virtual ~APP_SETTINGS_BASE ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aCfg) override
 Migrates from wxConfig to JSON-based configuration. More...
 
virtual const std::vector< wxString > DefaultGridSizeList () const
 By default, this returns the list of grids available in PcbNew-based applications. More...
 
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...
 
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)
 
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 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

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

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

APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.

It stores settings that should exist for every app, but may be different from app to app depending on the user's preferences.

COMMON_SETTINGS stores settings that are always the same across all applications.

Definition at line 99 of file app_settings.h.

Constructor & Destructor Documentation

◆ APP_SETTINGS_BASE()

APP_SETTINGS_BASE::APP_SETTINGS_BASE ( const std::string &  aFilename,
int  aSchemaVersion 
)

Definition at line 35 of file app_settings.cpp.

35  :
36  JSON_SETTINGS( aFilename, SETTINGS_LOC::USER, aSchemaVersion ),
38  m_FindReplace(),
39  m_Graphics(),
40  m_ColorPicker(),
41  m_LibTree(),
42  m_Printing(),
43  m_System(),
44  m_Window(),
45  m_appSettingsSchemaVersion( aSchemaVersion )
46 {
47  // Make Coverity happy:
48  m_LibTree.column_width = 360;
50 
51  // Build parameters list:
52  m_params.emplace_back( new PARAM<int>( "find_replace.flags", &m_FindReplace.flags, 1 ) );
53 
54  m_params.emplace_back( new PARAM<wxString>( "find_replace.find_string",
55  &m_FindReplace.find_string, "" ) );
56 
57  m_params.emplace_back( new PARAM_LIST<wxString>( "find_replace.find_history",
58  &m_FindReplace.find_history, {} ) );
59 
60  m_params.emplace_back( new PARAM<wxString>( "find_replace.replace_string",
62 
63  m_params.emplace_back( new PARAM_LIST<wxString>( "find_replace.replace_history",
65 
66  m_params.emplace_back( new PARAM<int>( "graphics.canvas_type",
68 
69  m_params.emplace_back( new PARAM<float>(
70  "graphics.highlight_factor", &m_Graphics.highlight_factor, 0.5f, 0.0, 1.0f ) );
71 
72  m_params.emplace_back( new PARAM<float>(
73  "graphics.select_factor", &m_Graphics.select_factor, 0.75f, 0.0, 1.0f ) );
74 
75  m_params.emplace_back( new PARAM<float>(
76  "graphics.high_contrast_factor", &m_Graphics.high_contrast_factor, 0.35f, 0.0, 1.0f ) );
77 
78  m_params.emplace_back( new PARAM<int>( "color_picker.default_tab",
79  &m_ColorPicker.default_tab, 0 ) );
80 
81  m_params.emplace_back( new PARAM<int>( "lib_tree.column_width",
82  &m_LibTree.column_width, 360 ) );
83 
84  // Now that we allow hiding/showing of the tree control, it's never terribly useful to
85  // decrease the width to nothing, and wxWidgets appears to have some bugs where it sets it
86  // way too narrow.
87  if( m_LibTree.column_width < 360 )
88  m_LibTree.column_width = 360;
89 
90  m_params.emplace_back( new PARAM<bool>( "printing.background",
91  &m_Printing.background, false ) );
92 
93  m_params.emplace_back( new PARAM<bool>( "printing.monochrome",
94  &m_Printing.monochrome, true ) );
95 
96  m_params.emplace_back( new PARAM<double>( "printing.scale",
97  &m_Printing.scale, 1.0 ) );
98 
99  m_params.emplace_back( new PARAM<bool>( "printing.use_theme",
100  &m_Printing.use_theme, false ) );
101 
102  m_params.emplace_back( new PARAM<wxString>( "printing.color_theme",
103  &m_Printing.color_theme, "" ) );
104 
105  m_params.emplace_back( new PARAM<bool>( "printing.title_block",
106  &m_Printing.title_block, false ) );
107 
108  m_params.emplace_back( new PARAM_LIST<int>( "printing.layers",
109  &m_Printing.layers, {} ) );
110 
111  m_params.emplace_back( new PARAM<bool>( "system.first_run_shown",
112  &m_System.first_run_shown, false ) );
113 
114  m_params.emplace_back( new PARAM<int>( "system.max_undo_items",
115  &m_System.max_undo_items, 0 ) );
116 
117 
118  m_params.emplace_back( new PARAM_LIST<wxString>( "system.file_history",
119  &m_System.file_history, {} ) );
120 
121  m_params.emplace_back( new PARAM<int>( "system.units",
122  &m_System.units, static_cast<int>( EDA_UNITS::MILLIMETRES ) ) );
123 
124  m_params.emplace_back( new PARAM<int>( "system.last_metric_units",
125  &m_System.last_metric_units, static_cast<int>( EDA_UNITS::MILLIMETRES ) ) );
126 
127  m_params.emplace_back( new PARAM<int>( "system.last_imperial_units",
128  &m_System.last_imperial_units, static_cast<int>( EDA_UNITS::INCHES ) ) );
129 
130  m_params.emplace_back( new PARAM<wxString>( "appearance.color_theme",
131  &m_ColorTheme, "_builtin_default" ) );
132 
133  addParamsForWindow( &m_Window, "window" );
134 
135  m_params.emplace_back( new PARAM<bool>( "cross_probing.center_on_items",
136  &m_CrossProbing.center_on_items, true ) );
137 
138  m_params.emplace_back( new PARAM<bool>( "cross_probing.zoom_to_fit",
139  &m_CrossProbing.zoom_to_fit, true ) );
140 
141  m_params.emplace_back( new PARAM<bool>( "cross_probing.auto_highlight",
142  &m_CrossProbing.auto_highlight, true ) );
143 }
void addParamsForWindow(WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
Adds parameters for the given window object.
std::vector< wxString > file_history
Definition: app_settings.h:146
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
std::vector< wxString > find_history
Definition: app_settings.h:108
static constexpr GAL_TYPE GAL_FALLBACK
wxString color_theme
Color theme to use for printing.
Definition: app_settings.h:137
bool title_block
Whether or not to print title block.
Definition: app_settings.h:138
bool use_theme
If false, display color theme will be used.
Definition: app_settings.h:136
float high_contrast_factor
How much to darken inactive layers by.
Definition: app_settings.h:118
bool monochrome
Whether or not to print in monochrome.
Definition: app_settings.h:134
FIND_REPLACE m_FindReplace
Definition: app_settings.h:169
std::vector< int > layers
List of enabled layers for printing.
Definition: app_settings.h:139
std::vector< wxString > replace_history
Definition: app_settings.h:110
float select_factor
How much to brighten selected objects by.
Definition: app_settings.h:117
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:63
bool background
Whether or not to print background color.
Definition: app_settings.h:133
bool zoom_to_fit
Zoom to fit items (ignored if center_on_items is off)
Definition: app_settings.h:33
int m_appSettingsSchemaVersion
! Local schema version for common app settings
Definition: app_settings.h:187
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181
bool auto_highlight
Automatically turn on highlight mode in the target frame.
Definition: app_settings.h:34
float highlight_factor
How much to brighten highlighted objects by.
Definition: app_settings.h:116
double scale
Printout scale.
Definition: app_settings.h:135
The main config directory (e.g. ~/.config/kicad/)
CROSS_PROBING_SETTINGS m_CrossProbing
Definition: app_settings.h:167
COLOR_PICKER m_ColorPicker
Definition: app_settings.h:173
bool center_on_items
Automatically pan to cross-probed items.
Definition: app_settings.h:32
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184

References addParamsForWindow(), CROSS_PROBING_SETTINGS::auto_highlight, APP_SETTINGS_BASE::PRINTING::background, APP_SETTINGS_BASE::GRAPHICS::canvas_type, CROSS_PROBING_SETTINGS::center_on_items, APP_SETTINGS_BASE::PRINTING::color_theme, APP_SETTINGS_BASE::LIB_TREE::column_width, APP_SETTINGS_BASE::COLOR_PICKER::default_tab, APP_SETTINGS_BASE::SYSTEM::file_history, APP_SETTINGS_BASE::FIND_REPLACE::find_history, APP_SETTINGS_BASE::FIND_REPLACE::find_string, APP_SETTINGS_BASE::SYSTEM::first_run_shown, APP_SETTINGS_BASE::FIND_REPLACE::flags, EDA_DRAW_PANEL_GAL::GAL_FALLBACK, APP_SETTINGS_BASE::GRAPHICS::high_contrast_factor, APP_SETTINGS_BASE::GRAPHICS::highlight_factor, INCHES, APP_SETTINGS_BASE::SYSTEM::last_imperial_units, APP_SETTINGS_BASE::SYSTEM::last_metric_units, APP_SETTINGS_BASE::PRINTING::layers, m_ColorPicker, m_ColorTheme, m_CrossProbing, m_FindReplace, m_Graphics, m_LibTree, JSON_SETTINGS::m_params, m_Printing, m_System, m_Window, APP_SETTINGS_BASE::SYSTEM::max_undo_items, MILLIMETRES, APP_SETTINGS_BASE::PRINTING::monochrome, APP_SETTINGS_BASE::FIND_REPLACE::replace_history, APP_SETTINGS_BASE::FIND_REPLACE::replace_string, APP_SETTINGS_BASE::PRINTING::scale, APP_SETTINGS_BASE::GRAPHICS::select_factor, APP_SETTINGS_BASE::PRINTING::title_block, APP_SETTINGS_BASE::SYSTEM::units, APP_SETTINGS_BASE::PRINTING::use_theme, USER, and CROSS_PROBING_SETTINGS::zoom_to_fit.

◆ ~APP_SETTINGS_BASE()

virtual APP_SETTINGS_BASE::~APP_SETTINGS_BASE ( )
inlinevirtual

Definition at line 154 of file app_settings.h.

154 {}

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

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

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

Referenced by NESTED_SETTINGS::SetParent().

◆ addParamsForWindow()

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

Adds parameters for the given window object.

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

Definition at line 269 of file app_settings.cpp.

270 {
271  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
272  &aWindow->state.maximized, false ) );
273 
274  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
275  &aWindow->mru_path, "" ) );
276 
277  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->state.size_x, 0 ) );
278 
279  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->state.size_y, 0 ) );
280 
281  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
282  &aWindow->perspective, "" ) );
283 
284  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->state.pos_x, 0 ) );
285 
286  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->state.pos_y, 0 ) );
287 
288  m_params.emplace_back( new PARAM<unsigned int>( aJsonPath + ".display", &aWindow->state.display, 0 ) );
289 
290  m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
291  &aWindow->zoom_factors, {} ) );
292 
293  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
294  &aWindow->grid.axes_enabled, false ) );
295 
296  m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
297  &aWindow->grid.sizes, DefaultGridSizeList() ) );
298 
299  // pcbnew default grid doesn't matter much, but eeschema does, so default to the index
300  // of the 50mil grid in eeschema
301  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
302  &aWindow->grid.last_size_idx, 1 ) );
303 
304  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
305  &aWindow->grid.fast_grid_1, 1 ) );
306 
307  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
308  &aWindow->grid.fast_grid_2, 2 ) );
309 
310  // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
311  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
312  &aWindow->grid.user_grid_x, "10 mil" ) );
313  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
314  &aWindow->grid.user_grid_y, "10 mil" ) );
315 
316  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
317  &aWindow->grid.line_width, 1.0 ) );
318 
319  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
320  &aWindow->grid.min_spacing, 10 ) );
321 
322  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
323  &aWindow->grid.show, true ) );
324 
325  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
326  &aWindow->grid.style, 0 ) );
327 
328  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.snap",
329  &aWindow->grid.snap, 0 ) );
330 
331  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
332  &aWindow->cursor.always_show_cursor, true ) );
333 
334  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
335  &aWindow->cursor.fullscreen_cursor, false ) );
336 }
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
virtual const std::vector< wxString > DefaultGridSizeList() const
By default, this returns the list of grids available in PcbNew-based applications.

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, DefaultGridSizeList(), 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(), CVPCB_SETTINGS::CVPCB_SETTINGS(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

◆ 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(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

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

Definition at line 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().

◆ DefaultGridSizeList()

const std::vector< wxString > APP_SETTINGS_BASE::DefaultGridSizeList ( ) const
virtual

By default, this returns the list of grids available in PcbNew-based applications.

Eeschema does not allow customization of the grid. If it ever does, override this in Eeschema settings to provide a different set of defaults.

Returns
a default value for the window.grid.sizes parameter

Definition at line 339 of file app_settings.cpp.

340 {
341  return { "1000 mil",
342  "500 mil",
343  "250 mil",
344  "200 mil",
345  "100 mil",
346  "50 mil",
347  "25 mil",
348  "20 mil",
349  "10 mil",
350  "5 mil",
351  "2 mil",
352  "1 mil",
353  "5.0 mm",
354  "2.5 mm",
355  "1.0 mm",
356  "0.5 mm",
357  "0.25 mm",
358  "0.2 mm",
359  "0.1 mm",
360  "0.05 mm",
361  "0.025 mm",
362  "0.01 mm" };
363 }

Referenced by addParamsForWindow(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), PCB_BASE_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), and DIALOG_GRID_SETTINGS::TransferDataToWindow().

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

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

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

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

References color.

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

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

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(), MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and 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 492 of file json_settings.cpp.

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

772 {
773  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
774  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
775 
776  return NULLOPT;
777 }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 269 of file json_settings.h.

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

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 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 472 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 274 of file json_settings.h.

275  {
276  return wxEmptyString;
277  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

virtual std::string APP_SETTINGS_BASE::getLegacyFrameName ( ) const
inlineprotectedvirtual

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 78 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

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

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

152 {
153  // First, load all params to default values
154  m_internals->clear();
155  Load();
156 
157  bool success = true;
158  bool migrated = false;
159  bool legacy_migrated = false;
160 
161  LOCALE_IO locale;
162 
163  auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
164  // Backup and restore during migration so that the original can be mutated if convenient
165  bool backed_up = false;
166  wxFileName temp;
167 
168  if( aPath.IsDirWritable() )
169  {
170  temp.AssignTempFileName( aPath.GetFullPath() );
171 
172  if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
173  {
174  wxLogTrace( traceSettings, "%s: could not create temp file for migration",
175  GetFullFilename() );
176  }
177  else
178  backed_up = true;
179  }
180 
181  // Silence popups if legacy file is read-only
182  wxLogNull doNotLog;
183 
184  wxConfigBase::DontCreateOnDemand();
185  auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
186 
187  // If migrate fails or is not implemented, fall back to built-in defaults that were
188  // already loaded above
189  if( !MigrateFromLegacy( cfg.get() ) )
190  {
191  wxLogTrace( traceSettings,
192  "%s: migrated; not all settings were found in legacy file",
193  GetFullFilename() );
194  }
195  else
196  {
197  wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
198  }
199 
200  if( backed_up )
201  {
202  cfg.reset();
203 
204  if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
205  {
206  wxLogTrace( traceSettings,
207  "migrate; copy temp file %s to %s failed",
208  temp.GetFullPath(), aPath.GetFullPath() );
209  }
210 
211  if( !wxRemoveFile( temp.GetFullPath() ) )
212  {
213  wxLogTrace( traceSettings,
214  "migrate; failed to remove temp file %s",
215  temp.GetFullPath() );
216  }
217  }
218 
219  // Either way, we want to clean up the old file afterwards
220  legacy_migrated = true;
221  };
222 
223  wxFileName path;
224 
225  if( aDirectory.empty() )
226  {
227  path.Assign( m_filename );
228  path.SetExt( getFileExt() );
229  }
230  else
231  {
232  wxString dir( aDirectory );
233  path.Assign( dir, m_filename, getFileExt() );
234  }
235 
236  if( !path.Exists() )
237  {
238  // Case 1: legacy migration, no .json extension yet
239  path.SetExt( getLegacyFileExt() );
240 
241  if( path.Exists() )
242  {
243  migrateFromLegacy( path );
244  }
245  // Case 2: legacy filename is different from new one
246  else if( !m_legacy_filename.empty() )
247  {
248  path.SetName( m_legacy_filename );
249 
250  if( path.Exists() )
251  migrateFromLegacy( path );
252  }
253  else
254  {
255  success = false;
256  }
257  }
258  else
259  {
260  if( !path.IsFileWritable() )
261  m_writeFile = false;
262 
263  try
264  {
265  FILE* fp = wxFopen( path.GetFullPath(), wxT( "rt" ) );
266 
267  if( fp )
268  {
269  *static_cast<nlohmann::json*>( m_internals.get() ) =
270  nlohmann::json::parse( fp, nullptr,
271  /* allow_exceptions = */ true,
272  /* ignore_comments = */ true );
273 
274  // If parse succeeds, check if schema migration is required
275  int filever = -1;
276 
277  try
278  {
279  filever = m_internals->Get<int>( "meta.version" );
280  }
281  catch( ... )
282  {
283  wxLogTrace( traceSettings, "%s: file version could not be read!",
284  GetFullFilename() );
285  success = false;
286  }
287 
288  if( filever >= 0 && filever < m_schemaVersion )
289  {
290  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
291  GetFullFilename(), filever, m_schemaVersion );
292 
293  if( Migrate() )
294  {
295  migrated = true;
296  }
297  else
298  {
299  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
300  }
301  }
302  else if( filever > m_schemaVersion )
303  {
304  wxLogTrace( traceSettings,
305  "%s: warning: file version %d is newer than latest (%d)",
306  GetFullFilename(), filever, m_schemaVersion );
307  }
308  }
309  else
310  {
311  wxLogTrace( traceSettings, "%s exists but can't be opened for read",
312  GetFullFilename() );
313  }
314  }
315  catch( nlohmann::json::parse_error& error )
316  {
317  wxLogTrace( traceSettings, "Json parse error reading %s: %s",
318  path.GetFullPath(), error.what() );
319  wxLogTrace( traceSettings, "Attempting migration in case file is in legacy format" );
320  migrateFromLegacy( path );
321  }
322  }
323 
324  // Now that we have new data in the JSON structure, load the params again
325  Load();
326 
327  // And finally load any nested settings
328  for( auto settings : m_nested_settings )
329  settings->LoadFromFile();
330 
331  wxLogTrace( traceSettings, "Loaded <%s> with schema %d", GetFullFilename(), m_schemaVersion );
332 
333  // If we migrated, clean up the legacy file (with no extension)
334  if( legacy_migrated || migrated )
335  {
336  if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
337  {
338  wxLogTrace( traceSettings, "Warning: could not remove legacy file %s",
339  path.GetFullPath() );
340  }
341 
342  // And write-out immediately so that we don't lose data if the program later crashes.
344  SaveToFile( aDirectory, true );
345  }
346 
347  return success;
348 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
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)
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::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
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
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.
bool m_writeFile
Whether or not the backing store file should be written.

References JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), path, JSON_SETTINGS::SaveToFile(), and traceSettings.

Referenced by SETTINGS_MANAGER::SaveColorSettings().

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

551 {
552  int filever = m_internals->Get<int>( "meta.version" );
553 
554  while( filever < m_schemaVersion )
555  {
556  if( !m_migrators.count( filever ) )
557  {
558  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
559  typeid( *this ).name(), filever );
560  return false;
561  }
562 
563  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
564 
565  if( pair.second() )
566  {
567  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
568  filever, pair.first );
569  filever = pair.first;
570  m_internals->At( "meta.version" ) = filever;
571  }
572  else
573  {
574  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
575  typeid( *this ).name(), filever, pair.first );
576  return false;
577  }
578  }
579 
580  return true;
581 }
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().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protected

! Migrates the find/replace history string lists

Definition at line 209 of file app_settings.cpp.

210 {
211  const int find_replace_history_size = 10;
212  nlohmann::json find_history = nlohmann::json::array();
213  nlohmann::json replace_history = nlohmann::json::array();
214  wxString tmp, find_key, replace_key;
215 
216  for( int i = 0; i < find_replace_history_size; ++i )
217  {
218  find_key.Printf( "FindStringHistoryList%d", i );
219  replace_key.Printf( "ReplaceStringHistoryList%d", i );
220 
221  if( aCfg->Read( find_key, &tmp ) )
222  find_history.push_back( tmp.ToStdString() );
223 
224  if( aCfg->Read( replace_key, &tmp ) )
225  replace_history.push_back( tmp.ToStdString() );
226  }
227 
228  Set( "find_replace.find_history", find_history );
229  Set( "find_replace.replace_history", replace_history );
230 }
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 l...
nlohmann::json json
Definition: gerbview.cpp:41

References JSON_SETTINGS::Set().

Referenced by MigrateFromLegacy().

◆ MigrateFromLegacy()

bool APP_SETTINGS_BASE::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 JSON_SETTINGS.

Reimplemented in PCBNEW_SETTINGS, EESCHEMA_SETTINGS, PCB_CALCULATOR_SETTINGS, EDA_3D_VIEWER_SETTINGS, SYMBOL_EDITOR_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, CVPCB_SETTINGS, BITMAP2CMP_SETTINGS, PL_EDITOR_SETTINGS, and KICAD_SETTINGS.

Definition at line 146 of file app_settings.cpp.

147 {
148  bool ret = true;
149 
150  const std::string f = getLegacyFrameName();
151 
152  ret &= fromLegacyString( aCfg, "LastFindString", "find_replace.find_string" );
153  ret &= fromLegacyString( aCfg, "LastReplaceString", "find_replace.replace_string" );
154 
155  migrateFindReplace( aCfg );
156 
157  ret &= fromLegacy<int>( aCfg, "canvas_type", "graphics.canvas_type" );
158 
159  ret &= fromLegacy<int>( aCfg, "P22LIB_TREE_MODEL_ADAPTERSelectorColumnWidth",
160  "lib_tree.column_width" );
161 
162  ret &= fromLegacy<bool>( aCfg, "PrintMonochrome", "printing.monochrome" );
163  ret &= fromLegacy<double>( aCfg, "PrintScale", "printing.scale" );
164  ret &= fromLegacy<bool>( aCfg, "PrintPageFrame", "printing.title_block" );
165 
166  {
167  nlohmann::json js = nlohmann::json::array();
168  wxString key;
169  bool val = false;
170 
171  for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
172  {
173  key.Printf( wxT( "PlotLayer_%d" ), i );
174 
175  if( aCfg->Read( key, &val ) && val )
176  js.push_back( i );
177  }
178 
179  Set( "printing.layers", js );
180  }
181 
182  ret &= fromLegacy<bool>( aCfg, f + "FirstRunShown", "system.first_run_shown" );
183  ret &= fromLegacy<int>( aCfg, f + "DevelMaxUndoItems", "system.max_undo_items" );
184  ret &= fromLegacy<int>( aCfg, f + "Units", "system.units" );
185 
186  {
187  int max_history_size = Pgm().GetCommonSettings()->m_System.file_history_size;
188  wxString file, key;
189  nlohmann::json js = nlohmann::json::array();
190 
191  for( int i = 1; i <= max_history_size; i++ )
192  {
193  key.Printf( "file%d", i );
194  file = aCfg->Read( key, wxEmptyString );
195 
196  if( !file.IsEmpty() )
197  js.push_back( file.ToStdString() );
198  }
199 
200  Set( "system.file_history", js );
201  }
202 
203  ret &= migrateWindowConfig( aCfg, f, "window" );
204 
205  return ret;
206 }
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 l...
void migrateFindReplace(wxConfigBase *aCfg)
! Migrates the find/replace history string lists
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
nlohmann::json json
Definition: gerbview.cpp:41
virtual std::string getLegacyFrameName() const
Definition: app_settings.h:191
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 migrateWindowConfig(wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
Migrates legacy window settings into the JSON document.

References JSON_SETTINGS::fromLegacyString(), getLegacyFrameName(), migrateFindReplace(), migrateWindowConfig(), PCB_LAYER_ID_COUNT, Pgm(), and JSON_SETTINGS::Set().

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), PL_EDITOR_SETTINGS::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().

◆ migrateWindowConfig()

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

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 233 of file app_settings.cpp.

235 {
236  bool ret = true;
237 
238  const std::string frameGDO = aFrame + "GalDisplayOptions";
239  const std::string cursorPath = aJsonPath + ".cursor";
240  const std::string gridPath = aJsonPath + ".grid";
241 
242  ret &= fromLegacy<bool>( aCfg, aFrame + "Maximized", aJsonPath + ".maximized" );
243  ret &= fromLegacyString( aCfg, aFrame + "MostRecentlyUsedPath", aJsonPath + ".mru_path" );
244  ret &= fromLegacy<int>( aCfg, aFrame + "Size_x", aJsonPath + ".size_x" );
245  ret &= fromLegacy<int>( aCfg, aFrame + "Size_y", aJsonPath + ".size_y" );
246  ret &= fromLegacyString( aCfg, aFrame + "Perspective", aJsonPath + ".perspective" );
247  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_x", aJsonPath + ".pos_x" );
248  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_y", aJsonPath + ".pos_y" );
249 
250  ret &= fromLegacy<bool>( aCfg, frameGDO + "ForceDisplayCursor", cursorPath + ".always_show_cursor" );
251  ret &= fromLegacy<bool>( aCfg, frameGDO + "CursorFullscreen", cursorPath + ".fullscreen_cursor" );
252 
253  ret &= fromLegacy<int>( aCfg, aFrame + "_LastGridSize", gridPath + ".last_size" );
254 
255  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid1", gridPath + ".fast_grid_1" );
256  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid2", gridPath + ".fast_grid_2" );
257 
258  ret &= fromLegacy<bool>( aCfg, frameGDO + "GridAxesEnabled", gridPath + ".axes_enabled" );
259  ret &= fromLegacy<double>( aCfg, frameGDO + "GridLineWidth", gridPath + ".line_width" );
260  ret &= fromLegacy<double>( aCfg, frameGDO + "GridMaxDensity", gridPath + ".min_spacing" );
261  ret &= fromLegacy<bool>( aCfg, frameGDO + "ShowGrid", gridPath + ".show" );
262  ret &= fromLegacy<int>( aCfg, frameGDO + "GridStyle", gridPath + ".style" );
263  ret &= fromLegacyColor( aCfg, frameGDO + "GridColor", gridPath + ".color" );
264 
265  return ret;
266 }
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(), MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().

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

543 {
544  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
545  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
546  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
547 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
int m_schemaVersion
Version of this settings schema.

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 748 of file json_settings.cpp.

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

373 {
374  if( !m_writeFile )
375  return false;
376 
377  // Default PROJECT won't have a filename set
378  if( m_filename.IsEmpty() )
379  return false;
380 
381  wxFileName path;
382 
383  if( aDirectory.empty() )
384  {
385  path.Assign( m_filename );
386  path.SetExt( getFileExt() );
387  }
388  else
389  {
390  wxString dir( aDirectory );
391  path.Assign( dir, m_filename, getFileExt() );
392  }
393 
394  if( !m_createIfMissing && !path.FileExists() )
395  {
396  wxLogTrace( traceSettings,
397  "File for %s doesn't exist and m_createIfMissing == false; not saving",
398  GetFullFilename() );
399  return false;
400  }
401 
402  // Ensure the path exists, and create it if not.
403  if( !path.DirExists() && !path.Mkdir() )
404  {
405  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
406  path.GetPath(), GetFullFilename() );
407  return false;
408  }
409 
410  if( ( path.FileExists() && !path.IsFileWritable() ) ||
411  ( !path.FileExists() && !path.IsDirWritable() ) )
412  {
413  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
414  return false;
415  }
416 
417  bool modified = false;
418 
419  for( auto settings : m_nested_settings )
420  modified |= settings->SaveToFile();
421 
422  modified |= Store();
423 
424  if( !modified && !aForce && path.FileExists() )
425  {
426  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
427  return false;
428  }
429  else if( !modified && !aForce && !m_createIfDefault )
430  {
431  wxLogTrace( traceSettings,
432  "%s contents still default and m_createIfDefault == false; not saving",
433  GetFullFilename() );
434  return false;
435  }
436 
437  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
438 
440  bool success = true;
441 
442  try
443  {
444  std::stringstream buffer;
445  buffer << std::setw( 2 ) << *m_internals << std::endl;
446 
447  wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
448 
449  if( !fileStream.IsOk()
450  || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
451  {
452  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
453  success = false;
454  }
455  }
456  catch( nlohmann::json::exception& error )
457  {
458  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
459  GetFullFilename(), error.what() );
460  success = false;
461  }
462  catch( ... )
463  {
464  wxLogTrace( traceSettings, "Error: could not save %s." );
465  success = false;
466  }
467 
468  return success;
469 }
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: locale_io.h:40
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
wxString m_filename
The filename (not including path) of this settings file (inicode)
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
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.
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_internals, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_writeFile, path, 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 >
template void JSON_SETTINGS::Set< const char * > ( const std::string &  aPath,
ValueType  aVal 
)
inherited

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

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

Definition at line 522 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), PARAM< wxString >::Store(), COLOR_MAP_PARAM::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< nlohmann::json >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 780 of file json_settings.cpp.

781 {
782  ( *m_internals )[aPath] = aVal.ToUTF8();
783 }

◆ SetFilename()

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

Definition at line 76 of file json_settings.h.

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

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 592 of file json_settings.cpp.

594 {
595  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
596 
597  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
598  {
599  aTarget = aObj.at( ptr ).get<wxString>();
600  return true;
601  }
602 
603  return false;
604 }
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 607 of file json_settings.cpp.

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

624 {
625  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
626 
627  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
628  {
629  aTarget = aObj.at( ptr ).get<int>();
630  return true;
631  }
632 
633  return false;
634 }
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 637 of file json_settings.cpp.

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

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 80 of file json_settings.h.

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

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 190 of file json_settings.h.

191  {
192  m_manager = aManager;
193  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

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

Returns
true if any part of the JSON document was updated

Definition at line 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_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion

! Local schema version for common app settings

Definition at line 187 of file app_settings.h.

◆ m_ColorPicker

COLOR_PICKER APP_SETTINGS_BASE::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 301 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 295 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_CrossProbing

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 307 of file json_settings.h.

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

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace

◆ m_Graphics

◆ m_internals

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

The filename of the wxConfig legacy file (if different from m_filename)

Definition at line 283 of file json_settings.h.

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

◆ m_LibTree

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 286 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

A pointer to the settings manager managing this file (may be null)

Definition at line 316 of file json_settings.h.

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

◆ m_migrators

std::map<int, std::pair<int, std::function<bool()> > > JSON_SETTINGS::m_migrators
protectedinherited

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 319 of file json_settings.h.

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings
protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 292 of file json_settings.h.

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

◆ m_params

◆ m_Printing

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

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

Definition at line 310 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_System

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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