KiCad PCB EDA Suite
EDA_3D_VIEWER_SETTINGS Class Reference

#include <eda_3d_viewer_settings.h>

Inheritance diagram for EDA_3D_VIEWER_SETTINGS:
APP_SETTINGS_BASE JSON_SETTINGS

Classes

struct  CAMERA_SETTINGS
 
struct  RENDER_SETTINGS
 

Public Member Functions

 EDA_3D_VIEWER_SETTINGS ()
 
virtual ~EDA_3D_VIEWER_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
const std::vector< wxString > DefaultGridSizeList () const
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
void SetLocation (SETTINGS_LOC aLocation)
 
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
 
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...
 
std::optional< 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 >
std::optional< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
std::optional< 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)
 
const std::string FormatAsString () const
 
bool LoadFromRawFile (const wxString &aPath)
 

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

RENDER_SETTINGS m_Render
 
CAMERA_SETTINGS m_Camera
 
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...
 
bool migrateLibTreeWidth ()
 Migrates the library tree width setting from a single column (Item) to multi-column. 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
 

Static Protected Member Functions

template<typename ResultType >
static ResultType fetchOrDefault (const nlohmann::json &aJson, const std::string &aKey, ResultType aDefault=ResultType())
 Helper to retrieve a value from a JSON object (dictionary) as a certain result type. More...
 

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
 

Private Member Functions

bool migrateSchema0to1 ()
 

Detailed Description

Definition at line 31 of file eda_3d_viewer_settings.h.

Constructor & Destructor Documentation

◆ EDA_3D_VIEWER_SETTINGS()

EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS ( )

Definition at line 35 of file eda_3d_viewer_settings.cpp.

37 m_Render(),
38 m_Camera()
39{
40 m_params.emplace_back( new PARAM_ENUM<RENDER_ENGINE>( "render.engine", &m_Render.engine,
44
45 m_params.emplace_back( new PARAM_ENUM<GRID3D_TYPE>( "render.grid_type", &m_Render.grid_type,
49
50 m_params.emplace_back( new PARAM_ENUM<MATERIAL_MODE>( "render.material_mode",
55
56 m_params.emplace_back( new PARAM_ENUM<ANTIALIASING_MODE>( "render.opengl_AA_mode",
61
62 m_params.emplace_back( new PARAM<COLOR4D>( "render.opengl_selection_color",
64 COLOR4D( 0.0, 1.0, 0.0, 1.0 ) ) );
65
66 // OpenGL options
67 m_params.emplace_back( new PARAM<bool>( "render.opengl_copper_thickness",
69 m_params.emplace_back( new PARAM<bool>( "render.opengl_show_model_bbox",
71 m_params.emplace_back( new PARAM<bool>( "render.opengl_highlight_on_rollover",
73 m_params.emplace_back( new PARAM<bool>( "render.opengl_AA_disableOnMove",
75 m_params.emplace_back( new PARAM<bool>( "render.opengl_thickness_disableOnMove",
77 m_params.emplace_back( new PARAM<bool>( "render.opengl_vias_disableOnMove",
79 m_params.emplace_back( new PARAM<bool>( "render.opengl_holes_disableOnMove",
81 m_params.emplace_back( new PARAM<bool>( "render.opengl_render_bbox_only_OnMove",
83
84 // Raytracing options
85 m_params.emplace_back( new PARAM<bool>( "render.raytrace_anti_aliasing",
87 m_params.emplace_back( new PARAM<bool>( "render.raytrace_backfloor",
88 &m_Render.raytrace_backfloor, false ) );
89 m_params.emplace_back( new PARAM<bool>( "render.raytrace_post_processing",
91 m_params.emplace_back( new PARAM<bool>( "render.raytrace_procedural_textures",
93 m_params.emplace_back( new PARAM<bool>( "render.raytrace_reflections",
95 m_params.emplace_back( new PARAM<bool>( "render.raytrace_refractions",
97 m_params.emplace_back( new PARAM<bool>( "render.raytrace_shadows",
98 &m_Render.raytrace_shadows, true ) );
99
100 m_params.emplace_back( new PARAM<int>( "render.raytrace_nrsamples_shadows",
102 m_params.emplace_back( new PARAM<int>( "render.raytrace_nrsamples_reflections",
104 m_params.emplace_back( new PARAM<int>( "render.raytrace_nrsamples_refractions",
106
107 m_params.emplace_back( new PARAM<int>( "render.raytrace_recursivelevel_reflections",
109 m_params.emplace_back( new PARAM<int>( "render.raytrace_recursivelevel_refractions",
111
112 m_params.emplace_back( new PARAM<float>( "render.raytrace_spread_shadows",
114 m_params.emplace_back( new PARAM<float>( "render.raytrace_spread_reflections",
116 m_params.emplace_back( new PARAM<float>( "render.raytrace_spread_refractions",
118
119 m_params.emplace_back( new PARAM<COLOR4D>( "render.raytrace_lightColorCamera",
121 COLOR4D( 0.2, 0.2, 0.2, 1.0 ) ) );
122
123 m_params.emplace_back( new PARAM<COLOR4D>( "render.raytrace_lightColorTop",
125 COLOR4D( 0.247, 0.247, 0.247, 1.0 ) ) );
126
127 m_params.emplace_back( new PARAM<COLOR4D>( "render.raytrace_lightColorBottom",
129 COLOR4D( 0.247, 0.247, 0.247, 1.0 ) ) );
130
131 std::vector<COLOR4D> default_colors =
132 {
133 COLOR4D( 0.168, 0.168, 0.168, 1.0 ),
134 COLOR4D( 0.168, 0.168, 0.168, 1.0 ),
135 COLOR4D( 0.168, 0.168, 0.168, 1.0 ),
136 COLOR4D( 0.168, 0.168, 0.168, 1.0 ),
137 COLOR4D( 0.168, 0.168, 0.168, 1.0 ),
138 COLOR4D( 0.168, 0.168, 0.168, 1.0 ),
139 COLOR4D( 0.168, 0.168, 0.168, 1.0 ),
140 COLOR4D( 0.168, 0.168, 0.168, 1.0 )
141 };
142
143 m_params.emplace_back( new PARAM_LIST<COLOR4D>( "render.raytrace_lightColor",
145 default_colors ) );
146
147 const std::vector<int> default_elevation =
148 {
149 67, 67, 67, 67, -67, -67, -67, -67,
150 };
151
152 m_params.emplace_back( new PARAM_LIST<int>( "render.raytrace_lightElevation",
154 default_elevation ) );
155
156 const std::vector<int> default_azimuth =
157 {
158 45, 135, 225, 315, 45, 135, 225, 315,
159 };
160
161 m_params.emplace_back( new PARAM_LIST<int>( "render.raytrace_lightAzimuth",
163 default_azimuth ) );
164
165 m_params.emplace_back( new PARAM<bool>( "render.realistic",
166 &m_Render.realistic, true ) );
167 m_params.emplace_back( new PARAM<bool>( "render.show_adhesive",
168 &m_Render.show_adhesive, true ) );
169 m_params.emplace_back( new PARAM<bool>( "render.show_axis",
170 &m_Render.show_axis, true ) );
171 m_params.emplace_back( new PARAM<bool>( "render.show_board_body",
172 &m_Render.show_board_body, true ) );
173 m_params.emplace_back( new PARAM<bool>( "render.show_comments",
174 &m_Render.show_comments, true ) );
175 m_params.emplace_back( new PARAM<bool>( "render.show_eco",
176 &m_Render.show_eco, true ) );
177 m_params.emplace_back( new PARAM<bool>( "render.show_footprints_insert",
179 m_params.emplace_back( new PARAM<bool>( "render.show_footprints_normal",
181 m_params.emplace_back( new PARAM<bool>( "render.show_footprints_virtual",
183 m_params.emplace_back( new PARAM<bool>( "render.show_footprints_not_in_posfile",
185 m_params.emplace_back( new PARAM<bool>( "render.show_silkscreen",
186 &m_Render.show_silkscreen, true ) );
187 m_params.emplace_back( new PARAM<bool>( "render.show_soldermask",
188 &m_Render.show_soldermask, true ) );
189 m_params.emplace_back( new PARAM<bool>( "render.show_solderpaste",
190 &m_Render.show_solderpaste, true ) );
191 m_params.emplace_back( new PARAM<bool>( "render.show_zones",
192 &m_Render.show_zones, true ) );
193 m_params.emplace_back( new PARAM<bool>( "render.subtract_mask_from_silk",
195 m_params.emplace_back( new PARAM<bool>( "render.clip_silk_on_via_annulus",
197 m_params.emplace_back( new PARAM<bool>( "render.plated_and_bare_copper",
199 m_params.emplace_back( new PARAM<bool>( "camera.animation_enabled",
200 &m_Camera.animation_enabled, true ) );
201 m_params.emplace_back( new PARAM<int>( "camera.moving_speed_multiplier",
203 m_params.emplace_back( new PARAM<double>( "camera.rotation_increment",
204 &m_Camera.rotation_increment, 10.0 ) );
205 m_params.emplace_back( new PARAM<int>( "camera.projection_mode",
207
209
210 registerMigration( 1, 2,
211 [&]() -> bool
212 {
213 Set( "render.opengl_copper_thickness", false );
214 return true;
215 } );
216}
@ NORMAL
Use all material properties from model file.
@ CAD_MODE
Use a gray shading based on diffuse material.
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
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...
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Stores an enum as an integer.
Definition: parameters.h:217
const int viewer3dSchemaVersion
! Update the schema version whenever a migration is required
std::vector< KIGFX::COLOR4D > raytrace_lightColor

References AA_8X, AA_NONE, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::animation_enabled, CAD_MODE, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::clip_silk_on_via_annulus, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, GRID_10MM, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::grid_type, m_Camera, JSON_SETTINGS::m_params, m_Render, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::material_mode, migrateSchema0to1(), EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::moving_speed_multiplier, NONE, NORMAL, OPENGL, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_AA_disableOnMove, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_AA_mode, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_copper_thickness, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_highlight_on_rollover, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_holes_disableOnMove, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_render_bbox_only_OnMove, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_selection_color, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_show_model_bbox, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_thickness_disableOnMove, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_vias_disableOnMove, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::projection_mode, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_anti_aliasing, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_backfloor, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightAzimuth, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColor, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorBottom, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorCamera, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorTop, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightElevation, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_nrsamples_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_nrsamples_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_nrsamples_shadows, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_post_processing, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_procedural_textures, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_recursivelevel_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_recursivelevel_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_shadows, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_spread_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_spread_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_spread_shadows, RAYTRACING, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::realistic, JSON_SETTINGS::registerMigration(), EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::renderPlatedPadsAsPlated, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::rotation_increment, JSON_SETTINGS::Set(), EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_adhesive, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_axis, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_board_body, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_comments, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_eco, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_insert, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_normal, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_not_in_posfile, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_virtual, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_silkscreen, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_soldermask, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_solderpaste, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_zones, and EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::subtract_mask_from_silk.

◆ ~EDA_3D_VIEWER_SETTINGS()

virtual EDA_3D_VIEWER_SETTINGS::~EDA_3D_VIEWER_SETTINGS ( )
inlinevirtual

Definition at line 106 of file eda_3d_viewer_settings.h.

106{}

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

784{
785 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
786 m_nested_settings.push_back( aSettings );
787}
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
wxString GetFilename() const
Definition: json_settings.h:73
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 291 of file app_settings.cpp.

292{
293 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
294 &aWindow->state.maximized, false ) );
295
296 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
297 &aWindow->mru_path, wxS( "" ) ) );
298
299 m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->state.size_x, 0 ) );
300
301 m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->state.size_y, 0 ) );
302
303 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
304 &aWindow->perspective, wxS( "" ) ) );
305
306 m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->state.pos_x, 0 ) );
307
308 m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->state.pos_y, 0 ) );
309
310 m_params.emplace_back( new PARAM<unsigned int>( aJsonPath + ".display", &aWindow->state.display, 0 ) );
311
312 m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
313 &aWindow->zoom_factors, {} ) );
314
315 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
316 &aWindow->grid.axes_enabled, false ) );
317
318 int defaultGridIdx;
319
320 if( m_filename == wxS( "pl_editor" ) )
321 {
322 defaultGridIdx = 1;
323
324 m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
325 &aWindow->grid.sizes, DefaultGridSizeList() ) );
326 }
327 else if( m_filename == wxS( "eeschema" ) || m_filename == wxS( "symbol_editor" ) )
328 {
329 defaultGridIdx = 1;
330
331 // Eeschema's grids are fixed to keep wires/pins connected
332 }
333 else
334 {
335 defaultGridIdx = 4;
336
337 m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
338 &aWindow->grid.sizes, DefaultGridSizeList() ) );
339 }
340
341 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
342 &aWindow->grid.last_size_idx, defaultGridIdx ) );
343
344 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
345 &aWindow->grid.fast_grid_1, defaultGridIdx ) );
346
347 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
348 &aWindow->grid.fast_grid_2, defaultGridIdx + 1 ) );
349
350 // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
351 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
352 &aWindow->grid.user_grid_x, "10 mil" ) );
353 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
354 &aWindow->grid.user_grid_y, "10 mil" ) );
355
356 m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
357 &aWindow->grid.line_width, 1.0 ) );
358
359 m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
360 &aWindow->grid.min_spacing, 10 ) );
361
362 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
363 &aWindow->grid.show, true ) );
364
365 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
366 &aWindow->grid.style, 0 ) );
367
368 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.snap",
369 &aWindow->grid.snap, 0 ) );
370
371 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
372 &aWindow->cursor.always_show_cursor, true ) );
373
374 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
375 &aWindow->cursor.fullscreen_cursor, false ) );
376}
const std::vector< wxString > DefaultGridSizeList() const
wxString m_filename
The filename (not including path) of this settings file (inicode)
bool always_show_cursor
Definition: app_settings.h:43
bool fullscreen_cursor
Definition: app_settings.h:44
wxString user_grid_x
Definition: app_settings.h:54
double line_width
Definition: app_settings.h:59
wxString user_grid_y
Definition: app_settings.h:55
double min_spacing
Definition: app_settings.h:60
std::vector< wxString > sizes
Definition: app_settings.h:53
CURSOR_SETTINGS cursor
Definition: app_settings.h:98
WINDOW_STATE state
Definition: app_settings.h:93
GRID_SETTINGS grid
Definition: app_settings.h:99
wxString mru_path
Definition: app_settings.h:94
std::vector< double > zoom_factors
Definition: app_settings.h:96
wxString perspective
Definition: app_settings.h:95
unsigned int display
Definition: app_settings.h:85

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, APP_SETTINGS_BASE::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_filename, 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().

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

112{
113 return m_internals->At( aPath );
114}
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

Referenced by EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

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

◆ DefaultGridSizeList()

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

Definition at line 379 of file app_settings.cpp.

380{
381 if( m_filename == wxS( "eeschema" ) || m_filename == wxS( "symbol_editor" ) )
382 {
383 return { wxS( "100 mil" ),
384 wxS( "50 mil" ),
385 wxS( "25 mil" ),
386 wxS( "10 mil" ),
387 wxS( "5 mil" ),
388 wxS( "2 mil" ),
389 wxS( "1 mil" ) };
390 }
391 else
392 {
393 return { wxS( "1000 mil" ),
394 wxS( "500 mil" ),
395 wxS( "250 mil" ),
396 wxS( "200 mil" ),
397 wxS( "100 mil" ),
398 wxS( "50 mil" ),
399 wxS( "25 mil" ),
400 wxS( "20 mil" ),
401 wxS( "10 mil" ),
402 wxS( "5 mil" ),
403 wxS( "2 mil" ),
404 wxS( "1 mil" ),
405 wxS( "5.0 mm" ),
406 wxS( "2.5 mm" ),
407 wxS( "1.0 mm" ),
408 wxS( "0.5 mm" ),
409 wxS( "0.25 mm" ),
410 wxS( "0.2 mm" ),
411 wxS( "0.1 mm" ),
412 wxS( "0.05 mm" ),
413 wxS( "0.025 mm" ),
414 wxS( "0.01 mm" ) };
415 }
416}

References JSON_SETTINGS::m_filename.

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

◆ fetchOrDefault()

template<typename ResultType >
template bool JSON_SETTINGS::fetchOrDefault ( const nlohmann::json aJson,
const std::string &  aKey,
ResultType  aDefault = ResultType() 
)
staticprotectedinherited

Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Template Parameters
ResultTypeis the type of the retrieved value.
Parameters
aJsonis the object to act on .
aKeyis the object key to retrieve the value for.
Returns
the result, or aDefault if aKey is not found.

Definition at line 842 of file json_settings.cpp.

844{
845 ResultType ret = aDefault;
846
847 try
848 {
849 if( aJson.contains( aKey ) )
850 ret = aJson.at( aKey ).get<ResultType>();
851 }
852 catch( ... )
853 {
854 }
855
856 return ret;
857}

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( ) const
inherited

Definition at line 471 of file json_settings.cpp.

472{
474
475 std::stringstream buffer;
476 buffer << std::setw( 2 ) << *m_internals << std::endl;
477
478 return buffer.str();
479}
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
std::vector< FAB_LAYER_COLOR > dummy

References dummy, and JSON_SETTINGS::m_internals.

Referenced by ROUTER_TOOL::saveRouterDebugLog().

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

697{
698 ValueType val;
699
700 if( aConfig->Read( aKey, &val ) )
701 {
702 try
703 {
704 ( *m_internals )[aDest] = val;
705 }
706 catch( ... )
707 {
708 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
709 return false;
710 }
711
712 return true;
713 }
714
715 return false;
716}

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

757{
758 wxString str;
759
760 if( aConfig->Read( aKey, &str ) )
761 {
763 color.SetFromWxString( str );
764
765 try
766 {
767 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
768 ( *m_internals )[aDest] = js;
769 }
770 catch( ... )
771 {
772 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
773 return false;
774 }
775
776 return true;
777 }
778
779 return false;
780}
int color
Definition: DXF_plotter.cpp:57
nlohmann::json json
Definition: gerbview.cpp:44

References color.

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 731 of file json_settings.cpp.

733{
734 wxString str;
735
736 if( aConfig->Read( aKey, &str ) )
737 {
738 try
739 {
740 ( *m_internals )[aDest] = str.ToUTF8();
741 }
742 catch( ... )
743 {
744 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
745 return false;
746 }
747
748 return true;
749 }
750
751 return false;
752}

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

◆ Get() [1/2]

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

Definition at line 813 of file json_settings.cpp.

814{
815 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
816 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
817
818 return std::nullopt;
819}
std::optional< 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....

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

template<typename ValueType >
template std::optional< 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 534 of file json_settings.cpp.

535{
536 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
537 {
538 try
539 {
540 return ret->get<ValueType>();
541 }
542 catch( ... )
543 {
544 }
545 }
546
547 return std::nullopt;
548}

References JSON_SETTINGS::GetJson().

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

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in DATABASE_LIB_SETTINGS, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 275 of file json_settings.h.

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

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 105 of file json_settings.cpp.

106{
107 return wxString( m_filename + "." + getFileExt() );
108}
virtual wxString getFileExt() const

References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.

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

◆ GetJson()

std::optional< 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 514 of file json_settings.cpp.

515{
516 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
517
518 if( m_internals->contains( ptr ) )
519 {
520 try
521 {
522 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
523 }
524 catch( ... )
525 {
526 }
527 }
528
529 return std::optional<nlohmann::json>{};
530}

References JSON_SETTINGS::m_internals.

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 280 of file json_settings.h.

281 {
282 return wxEmptyString;
283 }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 114 of file eda_3d_viewer_settings.h.

114{ return "Viewer3DFrameName"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 80 of file json_settings.h.

80{ 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 123 of file json_settings.cpp.

124{
125 return m_internals.get();
126}

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

130{
131 for( auto param : m_params )
132 {
133 try
134 {
135 param->Load( this, m_resetParamsIfMissing );
136 }
137 catch( ... )
138 {
139 // Skip unreadable parameters in file
140 wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
141 }
142 }
143}
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()

References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_DEFAULTS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), 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 146 of file json_settings.cpp.

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

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::LoadProject(), SETTINGS_MANAGER::loadProjectFile(), SETTINGS_MANAGER::MigrateIfNeeded(), SAVE_AS_TRAVERSER::OnFile(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString &  aPath)
inherited

Definition at line 482 of file json_settings.cpp.

483{
484 try
485 {
486 wxFFileInputStream fp( aPath, wxT( "rt" ) );
487 wxStdInputStream fstream( fp );
488
489 if( fp.IsOk() )
490 {
491 *static_cast<nlohmann::json*>( m_internals.get() ) =
492 nlohmann::json::parse( fstream, nullptr,
493 /* allow_exceptions = */ true,
494 /* ignore_comments = */ true );
495 }
496 else
497 {
498 return false;
499 }
500 }
501 catch( nlohmann::json::parse_error& error )
502 {
503 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ), aPath, error.what() );
504
505 return false;
506 }
507
508 // Now that we have new data in the JSON structure, load the params again
509 Load();
510 return true;
511}

References JSON_SETTINGS::Load(), JSON_SETTINGS::m_internals, parse(), and traceSettings.

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

593{
594 int filever = m_internals->Get<int>( "meta.version" );
595
596 while( filever < m_schemaVersion )
597 {
598 if( !m_migrators.count( filever ) )
599 {
600 wxLogTrace( traceSettings, wxT( "Migrator missing for %s version %d!" ),
601 typeid( *this ).name(), filever );
602 return false;
603 }
604
605 std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
606
607 if( pair.second() )
608 {
609 wxLogTrace( traceSettings, wxT( "Migrated %s from %d to %d" ), typeid( *this ).name(),
610 filever, pair.first );
611 filever = pair.first;
612 m_internals->At( "meta.version" ) = filever;
613 }
614 else
615 {
616 wxLogTrace( traceSettings, wxT( "Migration failed for %s from %d to %d" ),
617 typeid( *this ).name(), filever, pair.first );
618 return false;
619 }
620 }
621
622 return true;
623}
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>

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

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

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 231 of file app_settings.cpp.

232{
233 const int find_replace_history_size = 10;
234 nlohmann::json find_history = nlohmann::json::array();
235 nlohmann::json replace_history = nlohmann::json::array();
236 wxString tmp, find_key, replace_key;
237
238 for( int i = 0; i < find_replace_history_size; ++i )
239 {
240 find_key.Printf( "FindStringHistoryList%d", i );
241 replace_key.Printf( "ReplaceStringHistoryList%d", i );
242
243 if( aCfg->Read( find_key, &tmp ) )
244 find_history.push_back( tmp.ToStdString() );
245
246 if( aCfg->Read( replace_key, &tmp ) )
247 replace_history.push_back( tmp.ToStdString() );
248 }
249
250 Set( "find_replace.find_history", find_history );
251 Set( "find_replace.replace_history", replace_history );
252}

References JSON_SETTINGS::Set().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool EDA_3D_VIEWER_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 239 of file eda_3d_viewer_settings.cpp.

240{
241 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
242
243 ret &= fromLegacy<int>( aCfg, "RenderEngine", "render.engine" );
244 ret &= fromLegacy<int>( aCfg, "ShowGrid3D", "render.grid_type" );
245 ret &= fromLegacy<int>( aCfg, "Render_Material", "render.material_mode" );
246 ret &= fromLegacy<bool>( aCfg, "Render_OGL_ShowCopperThickness", "render.opengl_copper_thickness" );
247 ret &= fromLegacy<bool>( aCfg, "Render_OGL_ShowModelBoudingBoxes", "render.opengl_show_model_bbox" );
248 ret &= fromLegacy<bool>( aCfg, "Render_RAY_AntiAliasing", "render.raytrace_anti_aliasing" );
249 ret &= fromLegacy<bool>( aCfg, "Render_RAY_Backfloor", "render.raytrace_backfloor" );
250 ret &= fromLegacy<bool>( aCfg, "Render_RAY_PostProcess", "render.raytrace_post_processing" );
251 ret &= fromLegacy<bool>( aCfg, "Render_RAY_ProceduralTextures", "render.raytrace_procedural_textures" );
252 ret &= fromLegacy<bool>( aCfg, "Render_RAY_Reflections", "render.raytrace_reflections" );
253 ret &= fromLegacy<bool>( aCfg, "Render_RAY_Refractions", "render.raytrace_refractions" );
254 ret &= fromLegacy<bool>( aCfg, "Render_RAY_Shadows", "render.raytrace_shadows" );
255 ret &= fromLegacy<bool>( aCfg, "ShowRealisticMode", "render.realistic" );
256 ret &= fromLegacy<bool>( aCfg, "ShowAdhesiveLayers", "render.show_adhesive" );
257 ret &= fromLegacy<bool>( aCfg, "ShowAxis", "render.show_axis" );
258 ret &= fromLegacy<bool>( aCfg, "ShowBoardBody", "render.show_board_body" );
259 ret &= fromLegacy<bool>( aCfg, "ShowCommentsLayers", "render.show_comments" );
260 ret &= fromLegacy<bool>( aCfg, "ShowEcoLayers", "render.show_eco" );
261 ret &= fromLegacy<bool>( aCfg, "ShowFootprints_Insert", "render.show_footprints_insert" );
262 ret &= fromLegacy<bool>( aCfg, "ShowFootprints_Normal", "render.show_footprints_normal" );
263 ret &= fromLegacy<bool>( aCfg, "ShowFootprints_Virtual", "render.show_footprints_virtual" );
264 ret &= fromLegacy<bool>( aCfg, "ShowSilkScreenLayers", "render.show_silkscreen" );
265 ret &= fromLegacy<bool>( aCfg, "ShowSolderMasLayers", "render.show_soldermask" );
266 ret &= fromLegacy<bool>( aCfg, "ShowSolderPasteLayers", "render.show_solderpaste" );
267 ret &= fromLegacy<bool>( aCfg, "ShowZones", "render.show_zones" );
268 ret &= fromLegacy<bool>( aCfg, "SubtractMaskFromSilk", "render.subtract_mask_from_silk" );
269
270 auto do_color =
271 [&] ( const std::string& key_r, const std::string& key_g, const std::string& key_b,
272 std::string key_dest, double alpha = 1.0 )
273 {
274 COLOR4D color( 1, 1, 1, alpha );
275
276 if( aCfg->Read( key_r, &color.r )
277 && aCfg->Read( key_g, &color.g )
278 && aCfg->Read( key_b, &color.b ) )
279 {
280 Set( key_dest, color );
281 }
282 };
283
284 do_color( "BgColor_Red", "BgColor_Green", "BgColor_Blue", "colors.background_bottom" );
285 do_color( "BgColor_Red_Top", "BgColor_Green_Top", "BgColor_Blue_Top", "colors.background_top" );
286 do_color( "BoardBodyColor_Red", "BoardBodyColor_Green", "BoardBodyColor_Blue", "colors.board" );
287 do_color( "CopperColor_Red", "CopperColor_Green", "CopperColor_Blue", "colors.copper" );
288 do_color( "SilkColor_Red", "SilkColor_Green", "SilkColor_Blue", "colors.silkscreen_bottom" );
289 do_color( "SilkColor_Red", "SilkColor_Green", "SilkColor_Blue", "colors.silkscreen_top" );
290 do_color( "SMaskColor_Red", "SMaskColor_Green", "SMaskColor_Blue", "colors.soldermask", 0.83 );
291 do_color( "SPasteColor_Red", "SPasteColor_Green", "SPasteColor_Blue", "colors.solderpaste" );
292
293 return ret;
294}
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.

References color, APP_SETTINGS_BASE::MigrateFromLegacy(), and JSON_SETTINGS::Set().

Referenced by PCBNEW_SETTINGS::MigrateFromLegacy().

◆ migrateLibTreeWidth()

bool APP_SETTINGS_BASE::migrateLibTreeWidth ( )
protectedinherited

Migrates the library tree width setting from a single column (Item) to multi-column.

Definition at line 419 of file app_settings.cpp.

420{
421 // We used to store only the width of the first column, because there were only
422 // two possible columns.
423 if( std::optional<int> optWidth = Get<int>( "lib_tree.column_width" ) )
424 {
425 Set<nlohmann::json>( "lib_tree.column_widths", { { "Item", *optWidth } } );
426 At( "lib_tree" ).erase( "column_width" );
427 }
428
429 return true;
430}
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...

References JSON_SETTINGS::At().

Referenced by EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ migrateSchema0to1()

bool EDA_3D_VIEWER_SETTINGS::migrateSchema0to1 ( )
private

Schema version 0 to 1:

delete colors (they're now stored in the 'user' color theme.

Definition at line 219 of file eda_3d_viewer_settings.cpp.

220{
226 try
227 {
228 if( m_internals->contains( "colors" ) )
229 m_internals->erase( "colors" );
230 }
231 catch( ... )
232 {
233 }
234
235 return true;
236}

References JSON_SETTINGS::m_internals.

Referenced by EDA_3D_VIEWER_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 255 of file app_settings.cpp.

257{
258 bool ret = true;
259
260 const std::string frameGDO = aFrame + "GalDisplayOptions";
261 const std::string cursorPath = aJsonPath + ".cursor";
262 const std::string gridPath = aJsonPath + ".grid";
263
264 ret &= fromLegacy<bool>( aCfg, aFrame + "Maximized", aJsonPath + ".maximized" );
265 ret &= fromLegacyString( aCfg, aFrame + "MostRecentlyUsedPath", aJsonPath + ".mru_path" );
266 ret &= fromLegacy<int>( aCfg, aFrame + "Size_x", aJsonPath + ".size_x" );
267 ret &= fromLegacy<int>( aCfg, aFrame + "Size_y", aJsonPath + ".size_y" );
268 ret &= fromLegacyString( aCfg, aFrame + "Perspective", aJsonPath + ".perspective" );
269 ret &= fromLegacy<int>( aCfg, aFrame + "Pos_x", aJsonPath + ".pos_x" );
270 ret &= fromLegacy<int>( aCfg, aFrame + "Pos_y", aJsonPath + ".pos_y" );
271
272 ret &= fromLegacy<bool>( aCfg, frameGDO + "ForceDisplayCursor", cursorPath + ".always_show_cursor" );
273 ret &= fromLegacy<bool>( aCfg, frameGDO + "CursorFullscreen", cursorPath + ".fullscreen_cursor" );
274
275 ret &= fromLegacy<int>( aCfg, aFrame + "_LastGridSize", gridPath + ".last_size" );
276
277 ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid1", gridPath + ".fast_grid_1" );
278 ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid2", gridPath + ".fast_grid_2" );
279
280 ret &= fromLegacy<bool>( aCfg, frameGDO + "GridAxesEnabled", gridPath + ".axes_enabled" );
281 ret &= fromLegacy<double>( aCfg, frameGDO + "GridLineWidth", gridPath + ".line_width" );
282 ret &= fromLegacy<double>( aCfg, frameGDO + "GridMaxDensity", gridPath + ".min_spacing" );
283 ret &= fromLegacy<bool>( aCfg, frameGDO + "ShowGrid", gridPath + ".show" );
284 ret &= fromLegacy<int>( aCfg, frameGDO + "GridStyle", gridPath + ".style" );
285 ret &= fromLegacyColor( aCfg, frameGDO + "GridColor", gridPath + ".color" );
286
287 return ret;
288}
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 APP_SETTINGS_BASE::MigrateFromLegacy(), CVPCB_SETTINGS::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 583 of file json_settings.cpp.

585{
586 wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
587 wxASSERT( aNewSchemaVersion <= m_schemaVersion );
588 m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
589}

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(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_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 790 of file json_settings.cpp.

791{
792 if( !aSettings || !m_manager )
793 return;
794
795 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
796 [&aSettings]( const JSON_SETTINGS* aPtr ) {
797 return aPtr == aSettings;
798 } );
799
800 if( it != m_nested_settings.end() )
801 {
802 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
803 ( *it )->SaveToFile();
804 m_nested_settings.erase( it );
805 }
806
807 aSettings->SetParent( nullptr );
808}
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)

References JSON_SETTINGS::m_manager, 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 364 of file json_settings.cpp.

365{
366 for( auto param : m_params )
367 param->SetDefault();
368}

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

372{
373 if( !m_writeFile )
374 return false;
375
376 // Default PROJECT won't have a filename set
377 if( m_filename.IsEmpty() )
378 return false;
379
380 wxFileName path;
381
382 if( aDirectory.empty() )
383 {
384 path.Assign( m_filename );
385 path.SetExt( getFileExt() );
386 }
387 else
388 {
389 wxString dir( aDirectory );
390 path.Assign( dir, m_filename, getFileExt() );
391 }
392
393 if( !m_createIfMissing && !path.FileExists() )
394 {
395 wxLogTrace( traceSettings,
396 wxT( "File for %s doesn't exist and m_createIfMissing == false; not saving" ),
397 GetFullFilename() );
398 return false;
399 }
400
401 // Ensure the path exists, and create it if not.
402 if( !path.DirExists() && !path.Mkdir() )
403 {
404 wxLogTrace( traceSettings, wxT( "Warning: could not create path %s, can't save %s" ),
405 path.GetPath(), GetFullFilename() );
406 return false;
407 }
408
409 if( ( path.FileExists() && !path.IsFileWritable() ) ||
410 ( !path.FileExists() && !path.IsDirWritable() ) )
411 {
412 wxLogTrace( traceSettings, wxT( "File for %s is read-only; not saving" ), GetFullFilename() );
413 return false;
414 }
415
416 bool modified = false;
417
418 for( auto settings : m_nested_settings )
419 modified |= settings->SaveToFile();
420
421 modified |= Store();
422
423 if( !modified && !aForce && path.FileExists() )
424 {
425 wxLogTrace( traceSettings, wxT( "%s contents not modified, skipping save" ), GetFullFilename() );
426 return false;
427 }
428 else if( !modified && !aForce && !m_createIfDefault )
429 {
430 wxLogTrace( traceSettings,
431 wxT( "%s contents still default and m_createIfDefault == false; not saving" ),
432 GetFullFilename() );
433 return false;
434 }
435
436 wxLogTrace( traceSettings, wxT( "Saving %s" ), GetFullFilename() );
437
439 bool success = true;
440
441 try
442 {
443 std::stringstream buffer;
444 buffer << std::setw( 2 ) << *m_internals << std::endl;
445
446 wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
447
448 if( !fileStream.IsOk()
449 || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
450 {
451 wxLogTrace( traceSettings, wxT( "Warning: could not save %s" ), GetFullFilename() );
452 success = false;
453 }
454 }
455 catch( nlohmann::json::exception& error )
456 {
457 wxLogTrace( traceSettings, wxT( "Catch error: could not save %s. Json error %s" ),
458 GetFullFilename(), error.what() );
459 success = false;
460 }
461 catch( ... )
462 {
463 wxLogTrace( traceSettings, wxT( "Error: could not save %s." ) );
464 success = false;
465 }
466
467 return success;
468}
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...

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(), SETTINGS_MANAGER::MigrateIfNeeded(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT::PinLibrary(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PGM_BASE::SetLanguage(), and PROJECT::UnpinLibrary().

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

565{
566 m_internals->SetFromString( aPath, aVal );
567}

References JSON_SETTINGS::m_internals.

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

◆ Set() [2/3]

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

Definition at line 822 of file json_settings.cpp.

823{
824 ( *m_internals )[aPath] = aVal.ToUTF8();
825}

◆ Set() [3/3]

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

◆ SetFilename()

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

◆ SetIfPresent() [1/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 649 of file json_settings.cpp.

651{
652 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
653
654 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
655 {
656 aTarget = aObj.at( ptr ).get<bool>();
657 return true;
658 }
659
660 return false;
661}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/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 664 of file json_settings.cpp.

666{
667 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
668
669 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
670 {
671 aTarget = aObj.at( ptr ).get<int>();
672 return true;
673 }
674
675 return false;
676}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/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 679 of file json_settings.cpp.

681{
682 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
683
684 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
685 {
686 aTarget = aObj.at( ptr ).get<unsigned int>();
687 return true;
688 }
689
690 return false;
691}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/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 634 of file json_settings.cpp.

636{
637 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
638
639 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
640 {
641 aTarget = aObj.at( ptr ).get<wxString>();
642 return true;
643 }
644
645 return false;
646}

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetLegacyFilename()

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

Definition at line 82 of file json_settings.h.

82{ m_legacy_filename = aFilename; }

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 79 of file json_settings.h.

79{ m_location = aLocation; }

References JSON_SETTINGS::m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

192 {
193 m_manager = aManager;
194 }

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

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

351{
352 bool modified = false;
353
354 for( auto param : m_params )
355 {
356 modified |= !param->MatchesFile( this );
357 param->Store( this );
358 }
359
360 return modified;
361}

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings

Definition at line 193 of file app_settings.h.

◆ m_Camera

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

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

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

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

Referenced by JSON_SETTINGS::GetLocation(), and JSON_SETTINGS::SetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 333 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), JSON_SETTINGS::ReleaseNestedSettings(), 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 336 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 309 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_Render

RENDER_SETTINGS EDA_3D_VIEWER_SETTINGS::m_Render

Definition at line 110 of file eda_3d_viewer_settings.h.

Referenced by RENDER_3D_RAYTRACE::addModels(), EDA_3D_VIEWER_FRAME::applyViewport(), RENDER_3D_RAYTRACE::createItemsFromContainer(), BOARD_ADAPTER::createLayers(), EDA_3D_CANVAS::DoRePaint(), EDA_3D_VIEWER_SETTINGS(), EVT_TOOL_RANGE(), RENDER_3D_OPENGL::generateViasAndPads(), BOARD_ADAPTER::GetFootprintZPos(), RENDER_3D_OPENGL::getLayerColor(), RENDER_3D_RAYTRACE::getModelMaterial(), BOARD_ADAPTER::GetSphericalCoord(), EDA_3D_CONDITIONS::gridSizeFunction(), BOARD_ADAPTER::InitSettings(), RENDER_3D_RAYTRACE::insertHole(), BOARD_ADAPTER::Is3dLayerEnabled(), BOARD_ADAPTER::IsFootprintShown(), RENDER_3D_RAYTRACE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), EDA_3D_VIEWER_FRAME::LoadSettings(), PANEL_3D_OPENGL_OPTIONS::loadSettings(), PANEL_3D_RAYTRACING_OPTIONS::loadSettings(), PANEL_3D_DISPLAY_OPTIONS::loadViewSettings(), EDA_3D_CONTROLLER::On3DGridSelection(), EDA_3D_VIEWER_FRAME::onDisableRayTracing(), EDA_3D_CANVAS::OnMouseMove(), EDA_3D_VIEWER_FRAME::onRenderEngineSelection(), RENDER_3D_RAYTRACE::postProcessBlurFinish(), RENDER_3D_RAYTRACE::postProcessShading(), EDA_3D_VIEWER_FRAME::Redraw(), RENDER_3D_OPENGL::Redraw(), EDA_3D_VIEWER_FRAME::refreshRender(), RENDER_3D_OPENGL::reload(), RENDER_3D_RAYTRACE::Reload(), RENDER_3D_RAYTRACE::render(), RENDER_3D_OPENGL::render3dModelsSelected(), RENDER_3D_RAYTRACE::renderAntiAliasPackets(), RENDER_3D_RAYTRACE::renderBlockTracing(), EDA_3D_CANVAS::RenderEngineChanged(), RENDER_3D_OPENGL::renderFootprint(), EDA_3D_CONTROLLER::RotateView(), EDA_3D_VIEWER_FRAME::SaveSettings(), RENDER_3D_OPENGL::setLayerMaterial(), EDA_3D_CONTROLLER::SetMaterial(), RENDER_3D_OPENGL::setupMaterials(), RENDER_3D_RAYTRACE::setupMaterials(), EDA_3D_VIEWER_FRAME::setupUIConditions(), RENDER_3D_RAYTRACE::shadeHit(), EDA_3D_CONTROLLER::ToggleOrtho(), EDA_3D_CONTROLLER::ToggleVisibility(), PANEL_3D_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_3D_OPENGL_OPTIONS::TransferDataFromWindow(), and PANEL_3D_RAYTRACING_OPTIONS::TransferDataFromWindow().

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

WINDOW_SETTINGS APP_SETTINGS_BASE::m_Window
inherited

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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