KiCad PCB EDA Suite
FOOTPRINT_EDITOR_SETTINGS Class Reference

#include <footprint_editor_settings.h>

Inheritance diagram for FOOTPRINT_EDITOR_SETTINGS:
APP_SETTINGS_BASE JSON_SETTINGS

Classes

struct  USER_GRID
 

Public Member Functions

 FOOTPRINT_EDITOR_SETTINGS ()
 
virtual ~FOOTPRINT_EDITOR_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. 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)
 
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 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

BOARD_DESIGN_SETTINGS m_DesignSettings
 Only some of these settings are actually used for footprint editing. More...
 
MAGNETIC_SETTINGS m_MagneticItems
 
PCB_DISPLAY_OPTIONS m_Display
 
USER_GRID m_UserGrid
 
bool m_PolarCoords
 
bool m_Use45DegreeGraphicSegments
 
int m_LibWidth
 
wxString m_LastImportExportPath
 
wxString m_FootprintTextShownColumns
 
SELECTION_FILTER_OPTIONS m_SelectionFilter
 
std::vector< LAYER_PRESETm_LayerPresets
 
wxString m_ActiveLayerPreset
 
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...
 
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::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. More...
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 

Private Member Functions

bool migrateSchema0to1 ()
 

Detailed Description

Definition at line 30 of file footprint_editor_settings.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_EDITOR_SETTINGS()

FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS ( )

Definition at line 37 of file footprint_editor_settings.cpp.

37  :
39  m_DesignSettings( nullptr, "fpedit.settings" ),
41  m_Display(),
42  m_UserGrid(),
43  m_PolarCoords( false ),
45  m_LibWidth( 250 ),
48 {
51  m_MagneticItems.graphics = false;
52 
53  m_params.emplace_back( new PARAM<int>( "window.lib_width",
54  &m_LibWidth, 250 ) );
55 
56  m_params.emplace_back( new PARAM<wxString>( "system.last_import_export_path",
57  &m_LastImportExportPath, "" ) );
58 
59  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
60  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
61 
62  m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
63  reinterpret_cast<int*>( &m_MagneticItems.pads ),
64  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
65 
66  m_params.emplace_back( new PARAM<bool>( "editing.polar_coords", &m_PolarCoords, false ) );
67 
68  m_params.emplace_back( new PARAM<bool>( "editing.use_45_degree_graphic_segments",
69  &m_Use45DegreeGraphicSegments, false ) );
70 
71  m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
72  &m_Display.m_DisplayTextFill, true ) );
73 
74  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
76 
77  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
78  &m_Display.m_DisplayPadFill, true ) );
79 
80  m_params.emplace_back( new PARAM_LAYER_PRESET( "pcb_display.layer_presets", &m_LayerPresets ) );
81 
82  m_params.emplace_back( new PARAM<wxString>( "pcb_display.active_layer_preset",
83  &m_ActiveLayerPreset, "" ) );
84 
85  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>(
86  "design_settings.default_footprint_text_items",
87  [&] () -> nlohmann::json
88  {
89  nlohmann::json js = nlohmann::json::array();
90 
92  {
93  js.push_back( nlohmann::json( { item.m_Text.ToUTF8(),
94  item.m_Visible,
95  item.m_Layer } ) );
96  }
97 
98  return js;
99  },
100  [&] ( const nlohmann::json& aObj )
101  {
103 
104  if( !aObj.is_array() )
105  return;
106 
107  for( const nlohmann::json& entry : aObj )
108  {
109  if( entry.empty() || !entry.is_array() )
110  continue;
111 
112  TEXT_ITEM_INFO textInfo( wxT( "" ), true, F_SilkS );
113 
114  textInfo.m_Text = entry.at(0).get<wxString>();
115  textInfo.m_Visible = entry.at(1).get<bool>();
116  textInfo.m_Layer = entry.at(2).get<int>();
117 
118  m_DesignSettings.m_DefaultFPTextItems.push_back( std::move( textInfo ) );
119  }
120  },
121  nlohmann::json::array( {
122  { "REF**", true, F_SilkS },
123  { "", true, F_Fab },
124  { "${REFERENCE}", true, F_Fab }
125  } ) ) );
126 
127  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_line_width",
130  MM_PER_IU ) );
131 
132  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_h",
135 
136  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_v",
139 
140  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_thickness",
143 
144  m_params.emplace_back( new PARAM<bool>( "design_settings.silk_text_italic",
146 
147  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_line_width",
150  MM_PER_IU ) );
151 
152  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_h",
155  MM_PER_IU ) );
156 
157  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_v",
160  MM_PER_IU ) );
161 
162  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_thickness",
165  MM_PER_IU ) );
166 
167  m_params.emplace_back( new PARAM<bool>( "design_settings.copper_text_italic",
169 
170  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.edge_line_width",
173  MM_PER_IU ) );
174 
175  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.courtyard_line_width",
178  MM_PER_IU ) );
179 
180  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_line_width",
183  MM_PER_IU ) );
184 
185  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_h",
188 
189  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_v",
192 
193  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_thickness",
195  Millimeter2iu( DEFAULT_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
196 
197  m_params.emplace_back( new PARAM<bool>( "design_settings.fab_text_italic",
199 
200  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_line_width",
203  MM_PER_IU ) );
204 
205  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_h",
208 
209  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_v",
212 
213  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_thickness",
215  Millimeter2iu( DEFAULT_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
216 
217  m_params.emplace_back( new PARAM<bool>( "design_settings.others_text_italic",
219 
220  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "editing.selection_filter",
221  [&]() -> nlohmann::json
222  {
223  nlohmann::json ret;
224 
225  ret["lockedItems"] = m_SelectionFilter.lockedItems;
226  ret["footprints"] = m_SelectionFilter.footprints;
227  ret["text"] = m_SelectionFilter.text;
228  ret["tracks"] = m_SelectionFilter.tracks;
229  ret["vias"] = m_SelectionFilter.vias;
230  ret["pads"] = m_SelectionFilter.pads;
231  ret["graphics"] = m_SelectionFilter.graphics;
232  ret["zones"] = m_SelectionFilter.zones;
233  ret["keepouts"] = m_SelectionFilter.keepouts;
234  ret["dimensions"] = m_SelectionFilter.dimensions;
235  ret["otherItems"] = m_SelectionFilter.otherItems;
236 
237  return ret;
238  },
239  [&]( const nlohmann::json& aVal )
240  {
241  if( aVal.empty() || !aVal.is_object() )
242  return;
243 
244  SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
245  SetIfPresent( aVal, "footprints", m_SelectionFilter.footprints );
246  SetIfPresent( aVal, "text", m_SelectionFilter.text );
247  SetIfPresent( aVal, "tracks", m_SelectionFilter.tracks );
248  SetIfPresent( aVal, "vias", m_SelectionFilter.vias );
249  SetIfPresent( aVal, "pads", m_SelectionFilter.pads );
250  SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
251  SetIfPresent( aVal, "zones", m_SelectionFilter.zones );
252  SetIfPresent( aVal, "keepouts", m_SelectionFilter.keepouts );
253  SetIfPresent( aVal, "dimensions", m_SelectionFilter.dimensions );
254  SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
255  },
256  {
257  { "lockedItems", true },
258  { "footprints", true },
259  { "text", true },
260  { "tracks", true },
261  { "vias", true },
262  { "pads", true },
263  { "graphics", true },
264  { "zones", true },
265  { "keepouts", true },
266  { "dimensions", true },
267  { "otherItems", true }
268  } ) );
269 
271 }
#define DEFAULT_SILK_TEXT_WIDTH
bool otherItems
Anything not fitting one of the above categories.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
#define TEXTS_MAX_WIDTH
Maximum text width in internal units (10 inches)
Definition: pcbnew.h:33
#define DEFAULT_LINE_WIDTH
#define DEFAULT_COPPER_LINE_WIDTH
nlohmann::json json
Definition: gerbview.cpp:39
#define DEFAULT_TEXT_WIDTH
wxSize m_TextSize[LAYER_CLASS_COUNT]
const int fpEditSchemaVersion
! Update the schema version whenever a migration is required
#define DEFAULT_SILK_TEXT_SIZE
int m_TextThickness[LAYER_CLASS_COUNT]
#define DEFAULT_SILK_LINE_WIDTH
bool text
Text (free or attached to a footprint)
bool dimensions
Dimension items.
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
bool graphics
Graphic lines, shapes, polygons.
static bool SetIfPresent(const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
Sets the given string if the given key/path is present.
bool m_TextItalic[LAYER_CLASS_COUNT]
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition: parameters.h:388
SELECTION_FILTER_OPTIONS m_SelectionFilter
#define TEXTS_MAX_SIZE
Maximum text size in internal units (10 inches)
Definition: pcbnew.h:32
bool footprints
Allow selecting entire footprints.
int m_LineThickness[LAYER_CLASS_COUNT]
#define TEXTS_MIN_SIZE
Minimum text size in internal units (1 mil)
Definition: pcbnew.h:31
bool lockedItems
Allow selecting locked items.
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
std::vector< LAYER_PRESET > m_LayerPresets
MAGNETIC_OPTIONS pads
#define DEFAULT_COPPER_TEXT_WIDTH
#define DEFAULT_TEXT_SIZE
Ratio of the font height to the baseline of the text above the wire.
#define DEFAULT_COPPER_TEXT_SIZE
BOARD_DESIGN_SETTINGS m_DesignSettings
Only some of these settings are actually used for footprint editing.
static constexpr int Millimeter2iu(double mm)
MAGNETIC_OPTIONS tracks

References CAPTURE_CURSOR_IN_TRACK_TOOL, DEFAULT_COPPER_LINE_WIDTH, DEFAULT_COPPER_TEXT_SIZE, DEFAULT_COPPER_TEXT_WIDTH, DEFAULT_LINE_WIDTH, DEFAULT_SILK_LINE_WIDTH, DEFAULT_SILK_TEXT_SIZE, DEFAULT_SILK_TEXT_WIDTH, DEFAULT_TEXT_SIZE, DEFAULT_TEXT_WIDTH, SELECTION_FILTER_OPTIONS::dimensions, F_Fab, F_SilkS, SELECTION_FILTER_OPTIONS::footprints, MAGNETIC_SETTINGS::graphics, SELECTION_FILTER_OPTIONS::graphics, SELECTION_FILTER_OPTIONS::keepouts, LAYER_CLASS_COPPER, LAYER_CLASS_COURTYARD, LAYER_CLASS_EDGES, LAYER_CLASS_FAB, LAYER_CLASS_OTHERS, LAYER_CLASS_SILK, SELECTION_FILTER_OPTIONS::lockedItems, m_ActiveLayerPreset, BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, m_DesignSettings, m_Display, PCB_DISPLAY_OPTIONS::m_DisplayGraphicsFill, PCB_DISPLAY_OPTIONS::m_DisplayPadFill, PCB_DISPLAY_OPTIONS::m_DisplayTextFill, m_FootprintTextShownColumns, m_LastImportExportPath, TEXT_ITEM_INFO::m_Layer, m_LayerPresets, m_LibWidth, BOARD_DESIGN_SETTINGS::m_LineThickness, m_MagneticItems, JSON_SETTINGS::m_params, m_PolarCoords, m_SelectionFilter, TEXT_ITEM_INFO::m_Text, BOARD_DESIGN_SETTINGS::m_TextItalic, BOARD_DESIGN_SETTINGS::m_TextSize, BOARD_DESIGN_SETTINGS::m_TextThickness, m_Use45DegreeGraphicSegments, TEXT_ITEM_INFO::m_Visible, migrateSchema0to1(), Millimeter2iu(), SELECTION_FILTER_OPTIONS::otherItems, MAGNETIC_SETTINGS::pads, SELECTION_FILTER_OPTIONS::pads, JSON_SETTINGS::registerMigration(), JSON_SETTINGS::SetIfPresent(), SELECTION_FILTER_OPTIONS::text, TEXTS_MAX_SIZE, TEXTS_MAX_WIDTH, TEXTS_MIN_SIZE, SELECTION_FILTER_OPTIONS::tracks, MAGNETIC_SETTINGS::tracks, SELECTION_FILTER_OPTIONS::vias, and SELECTION_FILTER_OPTIONS::zones.

◆ ~FOOTPRINT_EDITOR_SETTINGS()

virtual FOOTPRINT_EDITOR_SETTINGS::~FOOTPRINT_EDITOR_SETTINGS ( )
inlinevirtual

Definition at line 42 of file footprint_editor_settings.h.

42 {}

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

657 {
658  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
659  m_nested_settings.push_back( aSettings );
660 }
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 262 of file app_settings.cpp.

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

570 {
571  ValueType val;
572 
573  if( aConfig->Read( aKey, &val ) )
574  {
575  try
576  {
577  ( *this )[PointerFromString( aDest )] = val;
578  }
579  catch( ... )
580  {
581  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
582  return false;
583  }
584 
585  return true;
586  }
587 
588  return false;
589 }
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 628 of file json_settings.cpp.

630 {
631  wxString str;
632 
633  if( aConfig->Read( aKey, &str ) )
634  {
636  color.SetFromWxString( str );
637 
638  try
639  {
640  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
641  ( *this )[PointerFromString( aDest )] = js;
642  }
643  catch( ... )
644  {
645  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
646  return false;
647  }
648 
649  return true;
650  }
651 
652  return false;
653 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:39
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:100

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

606 {
607  wxString str;
608 
609  if( aConfig->Read( aKey, &str ) )
610  {
611  try
612  {
613  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
614  }
615  catch( ... )
616  {
617  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
618  return false;
619  }
620 
621  return true;
622  }
623 
624  return false;
625 }
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(), MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 124 of file json_settings.h.

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

References JSON_SETTINGS::GetJson(), and NULLOPT.

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

◆ Get() [2/2]

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

Definition at line 686 of file json_settings.cpp.

687 {
688  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
689  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
690 
691  return NULLOPT;
692 }
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 274 of file json_settings.h.

275  {
276  return wxT( "json" );
277  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 79 of file json_settings.cpp.

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

418 {
419  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
420 
421  if( this->contains( ptr ) )
422  {
423  try
424  {
425  return OPT<nlohmann::json>{ this->at( ptr ) };
426  }
427  catch( ... )
428  {
429  }
430  }
431 
432  return OPT<nlohmann::json>{};
433 }
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

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

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 279 of file json_settings.h.

280  {
281  return wxEmptyString;
282  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 76 of file footprint_editor_settings.h.

76 { return "ModEditFrame"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 70 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 85 of file json_settings.cpp.

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

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

446 {
447  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
448 
449  while( filever < m_schemaVersion )
450  {
451  if( !m_migrators.count( filever ) )
452  {
453  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
454  typeid( *this ).name(), filever );
455  return false;
456  }
457 
458  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
459 
460  if( pair.second() )
461  {
462  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
463  filever, pair.first );
464  filever = pair.first;
465  ( *this )[PointerFromString( "meta.version" )] = filever;
466  }
467  else
468  {
469  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
470  typeid( *this ).name(), filever, pair.first );
471  return false;
472  }
473  }
474 
475  return true;
476 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

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

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

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 202 of file app_settings.cpp.

203 {
204  const int find_replace_history_size = 10;
205  nlohmann::json find_history = nlohmann::json::array();
206  nlohmann::json replace_history = nlohmann::json::array();
207  wxString tmp, find_key, replace_key;
208 
209  for( int i = 0; i < find_replace_history_size; ++i )
210  {
211  find_key.Printf( "FindStringHistoryList%d", i );
212  replace_key.Printf( "ReplaceStringHistoryList%d", i );
213 
214  if( aCfg->Read( find_key, &tmp ) )
215  find_history.push_back( tmp.ToStdString() );
216 
217  if( aCfg->Read( replace_key, &tmp ) )
218  replace_history.push_back( tmp.ToStdString() );
219  }
220 
221  ( *this )[PointerFromString( "find_replace.find_history" )] = find_history;
222  ( *this )[PointerFromString( "find_replace.replace_history" )] = replace_history;
223 }
nlohmann::json json
Definition: gerbview.cpp:39
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 FOOTPRINT_EDITOR_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 274 of file footprint_editor_settings.cpp.

275 {
276  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
277 
278  //
279  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
280  //
281  ret &= fromLegacy<int>( aCfg, "ModeditLibWidth", "window.lib_width" );
282  ret &= fromLegacyString( aCfg, "import_last_path", "system.last_import_export_path" );
283  ret &= fromLegacyString( aCfg, "LibFootprintTextShownColumns", "window.footprint_text_shown_columns" );
284 
285  ret &= fromLegacy<int>( aCfg, "FpEditorMagneticPads", "editing.magnetic_pads" );
286  ret &= fromLegacy<bool>( aCfg, "FpEditorDisplayPolarCoords", "editing.polar_coords" );
287  ret &= fromLegacy<int>( aCfg, "FpEditorUse45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
288 
289  ret &= fromLegacy<bool>( aCfg, "FpEditorGraphicLinesDisplayMode", "pcb_display.graphic_items_fill" );
290  ret &= fromLegacy<bool>( aCfg, "FpEditorPadDisplayMode", "pcb_display.pad_fill" );
291  ret &= fromLegacy<bool>( aCfg, "FpEditorTextsDisplayMode", "pcb_display.footprint_text" );
292 
293  ret &= fromLegacy<double>( aCfg, "FpEditorSilkLineWidth", "design_settings.silk_line_width" );
294  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeH", "design_settings.silk_text_size_h" );
295  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeV", "design_settings.silk_text_size_v" );
296  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextThickness", "design_settings.silk_text_thickness" );
297  ret &= fromLegacy<bool>( aCfg, "FpEditorSilkTextItalic", "design_settings.silk_text_italic" );
298  ret &= fromLegacy<double>( aCfg, "FpEditorCopperLineWidth", "design_settings.copper_line_width" );
299  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeH", "design_settings.copper_text_size_h" );
300  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeV", "design_settings.copper_text_size_v" );
301  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextThickness", "design_settings.copper_text_thickness" );
302  ret &= fromLegacy<bool>( aCfg, "FpEditorCopperTextItalic", "design_settings.copper_text_italic" );
303  ret &= fromLegacy<double>( aCfg, "FpEditorEdgeCutLineWidth", "design_settings.edge_line_width" );
304  ret &= fromLegacy<double>( aCfg, "FpEditorCourtyardLineWidth", "design_settings.courtyard_line_width" );
305  ret &= fromLegacy<double>( aCfg, "FpEditorOthersLineWidth", "design_settings.others_line_width" );
306  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeH", "design_settings.others_text_size_h" );
307  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeV", "design_settings.others_text_size_v" );
308  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextThickness", "design_settings.others_text_thickness" );
309  ret &= fromLegacy<bool>( aCfg, "FpEditorOthersTextItalic", "design_settings.others_text_italic" );
310 
311  nlohmann::json textItems = nlohmann::json::array( {
312  { "REF**", true, F_SilkS },
313  { "", true, F_Fab }
314  } );
315 
316  ( *this )[PointerFromString( "design_settings.default_footprint_text_items" )] = textItems;
317 
318  ret &= fromLegacyString( aCfg, "FpEditorRefDefaultText", "design_settings.default_footprint_text_items.0.0" );
319  ret &= fromLegacy<bool>( aCfg, "FpEditorRefDefaultVisibility", "design_settings.default_footprint_text_items.0.1" );
320  ret &= fromLegacy<int>( aCfg, "FpEditorRefDefaultLayer", "design_settings.default_footprint_text_items.0.2" );
321  ret &= fromLegacyString( aCfg, "FpEditorValueDefaultText", "design_settings.default_footprint_text_items.1.0" );
322  ret &= fromLegacy<bool>( aCfg, "FpEditorValueDefaultVisibility", "design_settings.default_footprint_text_items.1.1" );
323  ret &= fromLegacy<int>( aCfg, "FpEditorValueDefaultLayer", "design_settings.default_footprint_text_items.1.2" );
324 
325 
326  std::string f = "ModEdit";
327 
328  // Migrate color settings that were stored in the pcbnew config file
329  // We create a copy of the user scheme for the footprint editor context
330 
331  SETTINGS_MANAGER& manager = Pgm().GetSettingsManager();
332  COLOR_SETTINGS* cs = manager.AddNewColorSettings( "user_footprints" );
333 
334  cs->SetName( wxT( "User (Footprints)" ) );
335  manager.Save( cs );
336 
337  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId )
338  {
339  wxString str;
340 
341  if( aCfg->Read( aKey, &str ) )
342  cs->SetColor( aLayerId, COLOR4D( str ) );
343  };
344 
345  for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
346  {
347  wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
348  migrateLegacyColor( f + "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
349  }
350 
351  migrateLegacyColor( f + "Color4DAnchorEx", LAYER_ANCHOR );
352  migrateLegacyColor( f + "Color4DAuxItems", LAYER_AUX_ITEMS );
353  migrateLegacyColor( f + "Color4DGrid", LAYER_GRID );
354  migrateLegacyColor( f + "Color4DNoNetPadMarker", LAYER_NO_CONNECTS );
355  migrateLegacyColor( f + "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
356  migrateLegacyColor( f + "Color4DPadBackEx", LAYER_PAD_BK );
357  migrateLegacyColor( f + "Color4DPadFrontEx", LAYER_PAD_FR );
358  migrateLegacyColor( f + "Color4DPadThruHoleEx", LAYER_PADS_TH );
359  migrateLegacyColor( f + "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
360  migrateLegacyColor( f + "Color4DPCBCursor", LAYER_CURSOR );
361  migrateLegacyColor( f + "Color4DRatsEx", LAYER_RATSNEST );
362  migrateLegacyColor( f + "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
363  migrateLegacyColor( f + "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
364  migrateLegacyColor( f + "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
365  migrateLegacyColor( f + "Color4DViaThruEx", LAYER_VIA_THROUGH );
366  migrateLegacyColor( f + "Color4DWorksheet", LAYER_WORKSHEET );
367 
368  manager.SaveColorSettings( cs, "board" );
369 
370  ( *this )[PointerFromString( "appearance.color_theme" )] = "user_footprints";
371 
372  double x, y;
373  f = "ModEditFrame";
374 
375  if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
376  {
377  EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
378  static_cast<long>( EDA_UNITS::INCHES ) ) );
379 
380  // Convert to internal units
381  x = From_User_Unit( u, x );
382  y = From_User_Unit( u, y );
383 
384  ( *this )[PointerFromString( "window.grid.user_grid_x" )] = StringFromValue( u, x );
385  ( *this )[PointerFromString( "window.grid.user_grid_y" )] = StringFromValue( u, y );
386  }
387 
388  return ret;
389 }
to draw blind/buried vias
show a marker on pads with no nets
multilayer pads, usually with holes
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
COLOR_SETTINGS * AddNewColorSettings(const wxString &aFilename)
Registers a new color settings object with the given filename.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
nlohmann::json json
Definition: gerbview.cpp:39
PCB_LAYER_ID
A quick note on layer IDs:
Auxiliary items (guides, rule, etc)
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:82
to draw usual through hole vias
void SetName(const wxString &aName)
EDA_UNITS
Definition: eda_units.h:38
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
smd pads, front layer
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely saves a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Function StringFromValue returns the string from aValue according to units (inch, mm ....
Definition: base_units.cpp:220
Color settings are a bit different than most of the settings objects in that there can be more than o...
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
double From_User_Unit(EDA_UNITS aUnits, double aValue)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".
Definition: base_units.cpp:308
void SetColor(int aLayer, COLOR4D aColor)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References SETTINGS_MANAGER::AddNewColorSettings(), F_Fab, F_SilkS, From_User_Unit(), JSON_SETTINGS::fromLegacyString(), INCHES, LAYER_ANCHOR, LAYER_AUX_ITEMS, LAYER_CURSOR, LAYER_GRID, LAYER_MOD_TEXT_INVISIBLE, LAYER_NO_CONNECTS, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_PCB_BACKGROUND, LAYER_RATSNEST, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_WORKSHEET, APP_SETTINGS_BASE::MigrateFromLegacy(), LSET::Name(), PCB_LAYER_ID_COUNT, Pgm(), JSON_SETTINGS::PointerFromString(), SETTINGS_MANAGER::Save(), SETTINGS_MANAGER::SaveColorSettings(), COLOR_SETTINGS::SetColor(), COLOR_SETTINGS::SetName(), and StringFromValue().

Referenced by PCBNEW_SETTINGS::MigrateFromLegacy().

◆ migrateSchema0to1()

bool FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1 ( )
private

Schema version 0 to 1:

  • Check to see if a footprints version of the currently selected theme exists.
  • If so, select it

Definition at line 392 of file footprint_editor_settings.cpp.

393 {
401  if( !m_manager )
402  {
403  wxLogTrace( traceSettings,
404  "Error: FOOTPRINT_EDITOR_SETTINGS migration cannot run unmanaged!" );
405  return false;
406  }
407 
408  nlohmann::json::json_pointer theme_ptr( "/appearance/color_theme" );
409 
410  if( !count( theme_ptr ) )
411  return true;
412 
413  wxString selected = at( theme_ptr ).get<wxString>();
414  wxString search = selected + wxT( "_footprints" );
415 
416  for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
417  {
418  if( settings->GetFilename() == search )
419  {
420  wxLogTrace( traceSettings, "Updating footprint editor theme from %s to %s",
421  selected, search );
422  ( *this )[theme_ptr] = search;
423  return true;
424  }
425  }
426 
427  return true;
428 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
SETTINGS_MANAGER * GetSettingsManager()
Color settings are a bit different than most of the settings objects in that there can be more than o...
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References GetSettingsManager(), JSON_SETTINGS::m_manager, Pgm(), and traceSettings.

Referenced by FOOTPRINT_EDITOR_SETTINGS().

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

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

488 {
489  std::replace( aPath.begin(), aPath.end(), '.', '/' );
490  aPath.insert( 0, "/" );
491 
492  nlohmann::json::json_pointer p;
493 
494  try
495  {
496  p = nlohmann::json::json_pointer( aPath );
497  }
498  catch( ... )
499  {
500  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
501  }
502 
503  return p;
504 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), 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().

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

438 {
439  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
440  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
441  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
442 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
int m_schemaVersion
Version of this settings schema.

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

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

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 663 of file json_settings.cpp.

664 {
665  if( !aSettings )
666  return;
667 
668  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
669  [&aSettings]( const JSON_SETTINGS* aPtr ) {
670  return aPtr == aSettings;
671  } );
672 
673  if( it != m_nested_settings.end() )
674  {
675  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
676  ( *it )->SaveToFile();
677  m_nested_settings.erase( it );
678  }
679 
680  aSettings->SetParent( nullptr );
681 }
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 311 of file json_settings.cpp.

312 {
313  for( auto param : m_params )
314  param->SetDefault();
315 }
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 318 of file json_settings.cpp.

319 {
320  if( !m_writeFile )
321  return false;
322 
323  // Default PROJECT won't have a filename set
324  if( m_filename.IsEmpty() )
325  return false;
326 
327  wxFileName path;
328 
329  if( aDirectory.empty() )
330  {
331  path.Assign( m_filename );
332  path.SetExt( getFileExt() );
333  }
334  else
335  {
336  wxString dir( aDirectory );
337  path.Assign( dir, m_filename, getFileExt() );
338  }
339 
340  if( !m_createIfMissing && !path.FileExists() )
341  {
342  wxLogTrace( traceSettings,
343  "File for %s doesn't exist and m_createIfMissing == false; not saving",
344  GetFullFilename() );
345  return false;
346  }
347 
348  // Ensure the path exists, and create it if not.
349  if( !path.DirExists() && !path.Mkdir() )
350  {
351  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
352  path.GetPath(), GetFullFilename() );
353  return false;
354  }
355 
356  if( ( path.FileExists() && !path.IsFileWritable() ) ||
357  ( !path.FileExists() && !path.IsDirWritable() ) )
358  {
359  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
360  return false;
361  }
362 
363  bool modified = false;
364 
365  for( auto settings : m_nested_settings )
366  modified |= settings->SaveToFile();
367 
368  modified |= Store();
369 
370  if( !modified && !aForce && path.FileExists() )
371  {
372  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
373  return false;
374  }
375  else if( !modified && !aForce && !m_createIfDefault )
376  {
377  wxLogTrace( traceSettings,
378  "%s contents still default and m_createIfDefault == false; not saving",
379  GetFullFilename() );
380  return false;
381  }
382 
383  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
384 
386  bool success = true;
387 
388  try
389  {
390  std::stringstream buffer;
391  buffer << std::setw( 2 ) << *this << std::endl;
392 
393  wxFile file( path.GetFullPath(), wxFile::write );
394 
395  if( !file.IsOpened() || !file.Write( buffer.str().c_str(), buffer.str().size() ) )
396  {
397  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
398  success = false;
399  }
400  }
401  catch( nlohmann::json::exception& error )
402  {
403  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
404  GetFullFilename(), error.what() );
405  success = false;
406  }
407  catch( ... )
408  {
409  wxLogTrace( traceSettings, "Error: could not save %s." );
410  success = false;
411  }
412 
413  return success;
414 }
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
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 148 of file json_settings.h.

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

References JSON_SETTINGS::PointerFromString().

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

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 695 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetFilename()

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

Definition at line 68 of file json_settings.h.

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

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 507 of file json_settings.cpp.

509 {
510  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
511 
512  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
513  {
514  aTarget = aObj.at( ptr ).get<wxString>();
515  return true;
516  }
517 
518  return false;
519 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS(), 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 522 of file json_settings.cpp.

524 {
525  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
526 
527  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
528  {
529  aTarget = aObj.at( ptr ).get<bool>();
530  return true;
531  }
532 
533  return false;
534 }
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 537 of file json_settings.cpp.

539 {
540  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
541 
542  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
543  {
544  aTarget = aObj.at( ptr ).get<int>();
545  return true;
546  }
547 
548  return false;
549 }
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 552 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 72 of file json_settings.h.

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

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 188 of file json_settings.h.

189  {
190  m_manager = aManager;
191  }
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

Definition at line 75 of file json_settings.h.

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

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

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

Returns
true if any part of the JSON document was updated

Definition at line 297 of file json_settings.cpp.

298 {
299  bool modified = false;
300 
301  for( auto param : m_params )
302  {
303  modified |= !param->MatchesFile( this );
304  param->Store( this );
305  }
306 
307  return modified;
308 }
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_ActiveLayerPreset

wxString FOOTPRINT_EDITOR_SETTINGS::m_ActiveLayerPreset

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings

Definition at line 179 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 306 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 300 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 312 of file json_settings.h.

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

◆ m_DesignSettings

BOARD_DESIGN_SETTINGS FOOTPRINT_EDITOR_SETTINGS::m_DesignSettings

Only some of these settings are actually used for footprint editing.

Definition at line 48 of file footprint_editor_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS(), FOOTPRINT_EDIT_FRAME::LoadSettings(), and FOOTPRINT_EDIT_FRAME::SaveSettings().

◆ m_Display

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_FootprintTextShownColumns

wxString FOOTPRINT_EDITOR_SETTINGS::m_FootprintTextShownColumns

◆ m_Graphics

◆ m_LastImportExportPath

wxString FOOTPRINT_EDITOR_SETTINGS::m_LastImportExportPath

◆ m_LayerPresets

std::vector<LAYER_PRESET> FOOTPRINT_EDITOR_SETTINGS::m_LayerPresets

◆ 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 288 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 FOOTPRINT_EDITOR_SETTINGS::m_LibWidth

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 291 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_MagneticItems

MAGNETIC_SETTINGS FOOTPRINT_EDITOR_SETTINGS::m_MagneticItems

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 321 of file json_settings.h.

Referenced by 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 327 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 297 of file json_settings.h.

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

◆ m_params

◆ m_PolarCoords

bool FOOTPRINT_EDITOR_SETTINGS::m_PolarCoords

Definition at line 57 of file footprint_editor_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS().

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

◆ 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 315 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_SelectionFilter

◆ m_System

◆ m_Use45DegreeGraphicSegments

bool FOOTPRINT_EDITOR_SETTINGS::m_Use45DegreeGraphicSegments

Definition at line 59 of file footprint_editor_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS().

◆ m_UserGrid

USER_GRID FOOTPRINT_EDITOR_SETTINGS::m_UserGrid

Definition at line 55 of file footprint_editor_settings.h.

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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