KiCad PCB EDA Suite
EDA_3D_VIEWER_SETTINGS Class Reference

#include <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...
 
std::string GetFilename () const
 
wxString GetFullFilename () const
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const std::string &aFilename)
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const std::string &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const std::string &aDirectory="", bool aForce=false)
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
OPT< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
virtual bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 

Public Attributes

RENDER_SETTINGS m_Render
 
CAMERA_SETTINGS m_Camera
 
CROSS_PROBING_SETTINGS m_CrossProbing
 
FIND_REPLACE m_FindReplace
 
GRAPHICS m_Graphics
 
LIB_TREE m_LibTree
 
PRINTING m_Printing
 
SYSTEM m_System
 
WINDOW_SETTINGS m_Window
 
wxString m_ColorTheme
 Active color theme name. More...
 
int m_appSettingsSchemaVersion
 ! Local schema version for common app settings More...
 

Protected Member Functions

virtual std::string getLegacyFrameName () const override
 
void migrateFindReplace (wxConfigBase *aCfg)
 ! Migrates the find/replace history string lists More...
 
bool migrateWindowConfig (wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
 Migrates legacy window settings into the JSON document. More...
 
void addParamsForWindow (WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
 Adds parameters for the given window object. More...
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Protected Attributes

std::string m_filename
 The filename (not including path) of this settings file. More...
 
std::string m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. More...
 

Detailed Description

Definition at line 28 of file 3d_viewer_settings.h.

Constructor & Destructor Documentation

◆ EDA_3D_VIEWER_SETTINGS()

EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS ( )

Definition at line 34 of file 3d_viewer_settings.cpp.

35  : APP_SETTINGS_BASE( "3d_viewer", viewer3dSchemaVersion ),
36  m_Render(),
37  m_Camera()
38 {
39  m_params.emplace_back( new PARAM<int>( "render.engine", &m_Render.engine,
40  static_cast<int>( RENDER_ENGINE::OPENGL_LEGACY ),
41  static_cast<int>( RENDER_ENGINE::OPENGL_LEGACY ),
42  static_cast<int>( RENDER_ENGINE::RAYTRACING ) ) );
43 
44  m_params.emplace_back( new PARAM<int>( "render.grid_type", &m_Render.grid_type,
45  static_cast<int>( GRID3D_TYPE::NONE ),
46  static_cast<int>( GRID3D_TYPE::NONE ),
47  static_cast<int>( GRID3D_TYPE::GRID_10MM ) ) );
48 
49  m_params.emplace_back( new PARAM<int>( "render.material_mode", &m_Render.material_mode,
50  static_cast<int>( MATERIAL_MODE::NORMAL ),
51  static_cast<int>( MATERIAL_MODE::NORMAL ),
52  static_cast<int>( MATERIAL_MODE::CAD_MODE ) ) );
53 
54  m_params.emplace_back( new PARAM<int>( "render.opengl_AA_mode", &m_Render.opengl_AA_mode,
55  static_cast<int>( ANTIALIASING_MODE::AA_8X ),
56  static_cast<int>( ANTIALIASING_MODE::AA_NONE ),
57  static_cast<int>( ANTIALIASING_MODE::AA_8X ) ) );
58 
59  // OpenGL options
60  m_params.emplace_back( new PARAM<bool>(
61  "render.opengl_copper_thickness", &m_Render.opengl_copper_thickness, true ) );
62  m_params.emplace_back( new PARAM<bool>(
63  "render.opengl_show_model_bbox", &m_Render.opengl_show_model_bbox, false ) );
64  m_params.emplace_back( new PARAM<bool>(
65  "render.opengl_AA_disableOnMove", &m_Render.opengl_AA_disableOnMove, false ) );
66  m_params.emplace_back( new PARAM<bool>(
67  "render.opengl_thickness_disableOnMove", &m_Render.opengl_thickness_disableOnMove, false ) );
68  m_params.emplace_back( new PARAM<bool>(
69  "render.opengl_vias_disableOnMove", &m_Render.opengl_vias_disableOnMove, false ) );
70  m_params.emplace_back( new PARAM<bool>(
71  "render.opengl_holes_disableOnMove", &m_Render.opengl_holes_disableOnMove, false ) );
72  m_params.emplace_back( new PARAM<bool>(
73  "render.opengl_render_bbox_only_OnMove", &m_Render.opengl_render_bbox_only_OnMove, false ) );
74 
75  // Raytracing options
76  m_params.emplace_back( new PARAM<bool>( "render.raytrace_anti_aliasing",
78  m_params.emplace_back( new PARAM<bool>( "render.raytrace_backfloor",
79  &m_Render.raytrace_backfloor, false ) );
80  m_params.emplace_back( new PARAM<bool>( "render.raytrace_post_processing",
82  m_params.emplace_back( new PARAM<bool>( "render.raytrace_procedural_textures",
84  m_params.emplace_back( new PARAM<bool>( "render.raytrace_reflections",
85  &m_Render.raytrace_reflections, true ) );
86  m_params.emplace_back( new PARAM<bool>( "render.raytrace_refractions",
87  &m_Render.raytrace_refractions, true ) );
88  m_params.emplace_back( new PARAM<bool>( "render.raytrace_shadows",
89  &m_Render.raytrace_shadows, true ) );
90 
91  m_params.emplace_back( new PARAM<bool>( "render.realistic", &m_Render.realistic, true ) );
92  m_params.emplace_back(
93  new PARAM<bool>( "render.show_adhesive", &m_Render.show_adhesive, true ) );
94  m_params.emplace_back( new PARAM<bool>( "render.show_axis", &m_Render.show_axis, true ) );
95  m_params.emplace_back(
96  new PARAM<bool>( "render.show_board_body", &m_Render.show_board_body, true ) );
97  m_params.emplace_back(
98  new PARAM<bool>( "render.show_comments", &m_Render.show_comments, true ) );
99  m_params.emplace_back( new PARAM<bool>( "render.show_eco", &m_Render.show_eco, true ) );
100  m_params.emplace_back( new PARAM<bool>( "render.show_footprints_insert",
101  &m_Render.show_footprints_insert, true ) );
102  m_params.emplace_back( new PARAM<bool>( "render.show_footprints_normal",
103  &m_Render.show_footprints_normal, true ) );
104  m_params.emplace_back( new PARAM<bool>( "render.show_footprints_virtual",
106  m_params.emplace_back(
107  new PARAM<bool>( "render.show_silkscreen", &m_Render.show_silkscreen, true ) );
108  m_params.emplace_back(
109  new PARAM<bool>( "render.show_soldermask", &m_Render.show_soldermask, true ) );
110  m_params.emplace_back(
111  new PARAM<bool>( "render.show_solderpaste", &m_Render.show_solderpaste, true ) );
112  m_params.emplace_back( new PARAM<bool>( "render.show_zones", &m_Render.show_zones, true ) );
113  m_params.emplace_back( new PARAM<bool>( "render.subtract_mask_from_silk",
114  &m_Render.subtract_mask_from_silk, false ) );
115 
116  m_params.emplace_back( new PARAM<bool>( "camera.animation_enabled",
117  &m_Camera.animation_enabled, true ) );
118  m_params.emplace_back( new PARAM<int>( "camera.moving_speed_multiplier",
120  m_params.emplace_back( new PARAM<double>( "camera.rotation_increment",
121  &m_Camera.rotation_increment, 10.0 ) );
122 
123 }
Use a gray shading based on diffuse material.
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
const int viewer3dSchemaVersion
! Update the schema version whenever a migration is required
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
Use all material properties from model file.

References AA_8X, AA_NONE, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::animation_enabled, CAD_MODE, 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, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::moving_speed_multiplier, NONE, NORMAL, 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_holes_disableOnMove, OPENGL_LEGACY, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_render_bbox_only_OnMove, 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::RENDER_SETTINGS::raytrace_anti_aliasing, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_backfloor, 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_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_shadows, RAYTRACING, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::realistic, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::rotation_increment, 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_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 76 of file 3d_viewer_settings.h.

76 {}

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

500 {
501  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
502  m_nested_settings.push_back( aSettings );
503 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
std::string GetFilename() const
Definition: json_settings.h:56
const char * traceSettings
Flag to enable settings tracing.

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

238 {
239  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
240  &aWindow->maximized, false ) );
241 
242  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
243  &aWindow->mru_path, "" ) );
244 
245  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->size_x, 0 ) );
246 
247  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->size_y, 0 ) );
248 
249  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
250  &aWindow->perspective, "" ) );
251 
252  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->pos_x, 0 ) );
253 
254  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->pos_y, 0 ) );
255 
256  m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
257  &aWindow->zoom_factors, {} ) );
258 
259  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
260  &aWindow->grid.axes_enabled, false ) );
261 
262  m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
263  &aWindow->grid.sizes, {} ) );
264 
265  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
266  &aWindow->grid.last_size_idx, 0 ) );
267 
268  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
269  &aWindow->grid.fast_grid_1, 0 ) );
270 
271  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
272  &aWindow->grid.fast_grid_2, 1 ) );
273 
274  // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
275  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
276  &aWindow->grid.user_grid_x, "10 mil" ) );
277  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
278  &aWindow->grid.user_grid_y, "10 mil" ) );
279 
280  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
281  &aWindow->grid.line_width, 1.0 ) );
282 
283  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
284  &aWindow->grid.min_spacing, 10 ) );
285 
286  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
287  &aWindow->grid.show, true ) );
288 
289  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
290  &aWindow->grid.style, 0 ) );
291 
292  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
293  &aWindow->cursor.always_show_cursor, true ) );
294 
295  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
296  &aWindow->cursor.fullscreen_cursor, false ) );
297 }
wxString mru_path
Definition: app_settings.h:71
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:78
double line_width
Definition: app_settings.h:58
wxString perspective
Definition: app_settings.h:74
std::vector< wxString > sizes
Definition: app_settings.h:52
CURSOR_SETTINGS cursor
Definition: app_settings.h:80
GRID_SETTINGS grid
Definition: app_settings.h:81

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, 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_SETTINGS::maximized, GRID_SETTINGS::min_spacing, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_SETTINGS::pos_x, WINDOW_SETTINGS::pos_y, GRID_SETTINGS::show, WINDOW_SETTINGS::size_x, WINDOW_SETTINGS::size_y, GRID_SETTINGS::sizes, 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 411 of file json_settings.cpp.

413 {
414  ValueType val;
415 
416  if( aConfig->Read( aKey, &val ) )
417  {
418  try
419  {
420  ( *this )[PointerFromString( aDest )] = val;
421  }
422  catch( ... )
423  {
424  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
425  return false;
426  }
427 
428  return true;
429  }
430 
431  return false;
432 }
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 471 of file json_settings.cpp.

473 {
474  wxString str;
475 
476  if( aConfig->Read( aKey, &str ) )
477  {
479  color.SetFromWxString( str );
480 
481  try
482  {
483  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
484  ( *this )[PointerFromString( aDest )] = js;
485  }
486  catch( ... )
487  {
488  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
489  return false;
490  }
491 
492  return true;
493  }
494 
495  return false;
496 }
int color
Definition: DXF_plotter.cpp:61
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 447 of file json_settings.cpp.

449 {
450  wxString str;
451 
452  if( aConfig->Read( aKey, &str ) )
453  {
454  try
455  {
456  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
457  }
458  catch( ... )
459  {
460  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
461  return false;
462  }
463 
464  return true;
465  }
466 
467  return false;
468 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), LIBEDIT_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 111 of file json_settings.h.

112  {
113  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
114  {
115  try
116  {
117  return ret->get<ValueType>();
118  }
119  catch( ... )
120  {
121  }
122  }
123 
124  return NULLOPT;
125  }
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_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

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

Definition at line 529 of file json_settings.cpp.

530 {
531  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
532  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
533 
534  return NULLOPT;
535 }
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 217 of file json_settings.h.

218  {
219  return wxT( "json" );
220  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 69 of file json_settings.cpp.

70 {
71  return wxString( m_filename.c_str(), wxConvUTF8 ) + "." + getFileExt();
72 }
std::string m_filename
The filename (not including path) of this settings file.
virtual wxString getFileExt() const

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

Referenced by JSON_SETTINGS::JSON_SETTINGS(), 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 356 of file json_settings.cpp.

357 {
358  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
359 
360  if( this->contains( ptr ) )
361  {
362  try
363  {
364  return OPT<nlohmann::json>{ this->at( ptr ) };
365  }
366  catch( ... )
367  {
368  }
369  }
370 
371  return OPT<nlohmann::json>{};
372 }
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE.

Definition at line 222 of file json_settings.h.

223  {
224  return wxEmptyString;
225  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 85 of file 3d_viewer_settings.h.

85 { return "Viewer3DFrameName"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 60 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 75 of file json_settings.cpp.

76 {
77  for( auto param : m_params )
78  {
79  try
80  {
81  param->Load( this, m_resetParamsIfMissing );
82  }
83  catch( ... )
84  {
85  // Skip unreadable parameters in file:
86 #ifdef DEBUG
87  wxLogMessage( wxString::Format( "param '%s' load err", param->GetJsonPath().c_str() ) );
88 #endif
89  }
90  }
91 }
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()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format(), JSON_SETTINGS::m_params, and JSON_SETTINGS::m_resetParamsIfMissing.

Referenced by NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const std::string &  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 94 of file json_settings.cpp.

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

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

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
virtualinherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Reimplemented in COMMON_SETTINGS, COLOR_SETTINGS, and FOOTPRINT_EDITOR_SETTINGS.

Definition at line 375 of file json_settings.cpp.

376 {
377  wxLogTrace( traceSettings, "Migrate() not implemented for %s", typeid( *this ).name() );
378  return false;
379 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 177 of file app_settings.cpp.

178 {
179  const int find_replace_history_size = 10;
180  nlohmann::json find_history = nlohmann::json::array();
181  nlohmann::json replace_history = nlohmann::json::array();
182  wxString tmp, find_key, replace_key;
183 
184  for( int i = 0; i < find_replace_history_size; ++i )
185  {
186  find_key.Printf( "FindStringHistoryList%d", i );
187  replace_key.Printf( "ReplaceStringHistoryList%d", i );
188 
189  if( aCfg->Read( find_key, &tmp ) )
190  find_history.push_back( tmp.ToStdString() );
191 
192  if( aCfg->Read( replace_key, &tmp ) )
193  replace_history.push_back( tmp.ToStdString() );
194  }
195 
196  ( *this )[PointerFromString( "find_replace.find_history" )] = find_history;
197  ( *this )[PointerFromString( "find_replace.replace_history" )] = replace_history;
198 }
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool 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 126 of file 3d_viewer_settings.cpp.

127 {
128  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
129 
130  ret &= fromLegacy<int>( aCfg, "RenderEngine", "render.engine" );
131  ret &= fromLegacy<int>( aCfg, "ShowGrid3D", "render.grid_type" );
132  ret &= fromLegacy<int>( aCfg, "Render_Material", "render.material_mode" );
133  ret &= fromLegacy<bool>(
134  aCfg, "Render_OGL_ShowCopperThickness", "render.opengl_copper_thickness" );
135  ret &= fromLegacy<bool>(
136  aCfg, "Render_OGL_ShowModelBoudingBoxes", "render.opengl_show_model_bbox" );
137  ret &= fromLegacy<bool>( aCfg, "Render_RAY_AntiAliasing", "render.raytrace_anti_aliasing" );
138  ret &= fromLegacy<bool>( aCfg, "Render_RAY_Backfloor", "render.raytrace_backfloor" );
139  ret &= fromLegacy<bool>( aCfg, "Render_RAY_PostProcess", "render.raytrace_post_processing" );
140  ret &= fromLegacy<bool>(
141  aCfg, "Render_RAY_ProceduralTextures", "render.raytrace_procedural_textures" );
142  ret &= fromLegacy<bool>( aCfg, "Render_RAY_Reflections", "render.raytrace_reflections" );
143  ret &= fromLegacy<bool>( aCfg, "Render_RAY_Refractions", "render.raytrace_refractions" );
144  ret &= fromLegacy<bool>( aCfg, "Render_RAY_Shadows", "render.raytrace_shadows" );
145  ret &= fromLegacy<bool>( aCfg, "ShowRealisticMode", "render.realistic" );
146  ret &= fromLegacy<bool>( aCfg, "ShowAdhesiveLayers", "render.show_adhesive" );
147  ret &= fromLegacy<bool>( aCfg, "ShowAxis", "render.show_axis" );
148  ret &= fromLegacy<bool>( aCfg, "ShowBoardBody", "render.show_board_body" );
149  ret &= fromLegacy<bool>( aCfg, "ShowCommentsLayers", "render.show_comments" );
150  ret &= fromLegacy<bool>( aCfg, "ShowEcoLayers", "render.show_eco" );
151  ret &= fromLegacy<bool>( aCfg, "ShowFootprints_Insert", "render.show_footprints_insert" );
152  ret &= fromLegacy<bool>( aCfg, "ShowFootprints_Normal", "render.show_footprints_normal" );
153  ret &= fromLegacy<bool>( aCfg, "ShowFootprints_Virtual", "render.show_footprints_virtual" );
154  ret &= fromLegacy<bool>( aCfg, "ShowSilkScreenLayers", "render.show_silkscreen" );
155  ret &= fromLegacy<bool>( aCfg, "ShowSolderMasLayers", "render.show_soldermask" );
156  ret &= fromLegacy<bool>( aCfg, "ShowSolderPasteLayers", "render.show_solderpaste" );
157  ret &= fromLegacy<bool>( aCfg, "ShowZones", "render.show_zones" );
158  ret &= fromLegacy<bool>( aCfg, "SubtractMaskFromSilk", "render.subtract_mask_from_silk" );
159 
160  auto migrate_color =
161  [&] ( const std::string& k_r, const std::string& k_g,
162  const std::string &k_b, std::string dest )
163  {
164  COLOR4D color( 1, 1, 1, 1 );
165 
166  if( aCfg->Read( k_r, &color.r ) &&
167  aCfg->Read( k_g, &color.g ) && aCfg->Read( k_b, &color.b ) )
168  {
169  ( *this )[PointerFromString( dest )] = color;
170  }
171  };
172 
173  migrate_color( "BgColor_Red", "BgColor_Green", "BgColor_Blue", "colors.background_bottom" );
174  migrate_color(
175  "BgColor_Red_Top", "BgColor_Green_Top", "BgColor_Blue_Top", "colors.background_top" );
176  migrate_color(
177  "BoardBodyColor_Red", "BoardBodyColor_Green", "BoardBodyColor_Blue", "colors.board" );
178  migrate_color( "CopperColor_Red", "CopperColor_Green", "CopperColor_Blue", "colors.copper" );
179  migrate_color(
180  "SilkColor_Red", "SilkColor_Green", "SilkColor_Blue", "colors.silkscreen_bottom" );
181  migrate_color( "SilkColor_Red", "SilkColor_Green", "SilkColor_Blue", "colors.silkscreen_top" );
182  migrate_color( "SMaskColor_Red", "SMaskColor_Green", "SMaskColor_Blue", "colors.soldermask" );
183  migrate_color(
184  "SPasteColor_Red", "SPasteColor_Green", "SPasteColor_Blue", "colors.solderpaste" );
185 
186  return ret;
187 }
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
int color
Definition: DXF_plotter.cpp:61
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

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

Referenced by PCBNEW_SETTINGS::MigrateFromLegacy().

◆ migrateWindowConfig()

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

Migrates legacy window settings into the JSON document.

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

Definition at line 201 of file app_settings.cpp.

203 {
204  bool ret = true;
205 
206  const std::string frameGDO = aFrame + "GalDisplayOptions";
207  const std::string cursorPath = aJsonPath + ".cursor";
208  const std::string gridPath = aJsonPath + ".grid";
209 
210  ret &= fromLegacy<bool>( aCfg, aFrame + "Maximized", aJsonPath + ".maximized" );
211  ret &= fromLegacyString( aCfg, aFrame + "MostRecentlyUsedPath", aJsonPath + ".mru_path" );
212  ret &= fromLegacy<int>( aCfg, aFrame + "Size_x", aJsonPath + ".size_x" );
213  ret &= fromLegacy<int>( aCfg, aFrame + "Size_y", aJsonPath + ".size_y" );
214  ret &= fromLegacyString( aCfg, aFrame + "Perspective", aJsonPath + ".perspective" );
215  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_x", aJsonPath + ".pos_x" );
216  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_y", aJsonPath + ".pos_y" );
217 
218  ret &= fromLegacy<bool>( aCfg, frameGDO + "ForceDisplayCursor", cursorPath + ".always_show_cursor" );
219  ret &= fromLegacy<bool>( aCfg, frameGDO + "CursorFullscreen", cursorPath + ".fullscreen_cursor" );
220 
221  ret &= fromLegacy<int>( aCfg, aFrame + "_LastGridSize", gridPath + ".last_size" );
222 
223  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid1", gridPath + ".fast_grid_1" );
224  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid2", gridPath + ".fast_grid_2" );
225 
226  ret &= fromLegacy<bool>( aCfg, frameGDO + "GridAxesEnabled", gridPath + ".axes_enabled" );
227  ret &= fromLegacy<double>( aCfg, frameGDO + "GridLineWidth", gridPath + ".line_width" );
228  ret &= fromLegacy<double>( aCfg, frameGDO + "GridMaxDensity", gridPath + ".min_spacing" );
229  ret &= fromLegacy<bool>( aCfg, frameGDO + "ShowGrid", gridPath + ".show" );
230  ret &= fromLegacy<int>( aCfg, frameGDO + "GridStyle", gridPath + ".style" );
231  ret &= fromLegacyColor( aCfg, frameGDO + "GridColor", gridPath + ".color" );
232 
233  return ret;
234 }
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 390 of file json_settings.cpp.

391 {
392  std::replace( aPath.begin(), aPath.end(), '.', '/' );
393  aPath.insert( 0, "/" );
394 
395  nlohmann::json::json_pointer p;
396 
397  try
398  {
399  p = nlohmann::json::json_pointer( aPath );
400  }
401  catch( ... )
402  {
403  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
404  }
405 
406  return p;
407 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), FOOTPRINT_EDITOR_SETTINGS::Migrate(), COLOR_SETTINGS::Migrate(), COMMON_SETTINGS::Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), 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(), and JSON_SETTINGS::Set().

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

507 {
508  if( !aSettings )
509  return;
510 
511  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
512  [&aSettings]( const JSON_SETTINGS* aPtr ) {
513  return aPtr == aSettings;
514  } );
515 
516  if( it != m_nested_settings.end() )
517  {
518  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
519  ( *it )->SaveToFile();
520  m_nested_settings.erase( it );
521  }
522 
523  aSettings->SetParent( nullptr );
524 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.
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 272 of file json_settings.cpp.

273 {
274  for( auto param : m_params )
275  param->SetDefault();
276 }
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().

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const std::string &  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 279 of file json_settings.cpp.

280 {
281  if( !m_writeFile )
282  return false;
283 
284  // Default PROJECT won't have a filename set
285  if( m_filename.empty() )
286  return false;
287 
288  wxFileName path;
289 
290  if( aDirectory.empty() )
291  {
292  path.Assign( m_filename );
293  path.SetExt( getFileExt() );
294  }
295  else
296  {
297  path.Assign( aDirectory, m_filename, getFileExt() );
298  }
299 
300  if( !m_createIfMissing && !path.FileExists() )
301  {
302  wxLogTrace( traceSettings,
303  "File for %s doesn't exist and m_createIfMissing == false; not saving",
304  GetFullFilename() );
305  return false;
306  }
307 
308  bool modified = false;
309 
310  for( auto settings : m_nested_settings )
311  modified |= settings->SaveToFile();
312 
313  modified |= Store();
314 
315  if( !modified && !aForce && path.FileExists() )
316  {
317  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
318  return false;
319  }
320  else if( !modified && !aForce && !m_createIfDefault )
321  {
322  wxLogTrace( traceSettings,
323  "%s contents still default and m_createIfDefault == false; not saving",
324  GetFullFilename() );
325  return false;
326  }
327 
328  if( !path.DirExists() && !path.Mkdir() )
329  {
330  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
331  path.GetPath(), GetFullFilename() );
332  return false;
333  }
334 
335  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
336 
338 
339  try
340  {
341  std::ofstream file( path.GetFullPath().ToStdString() );
342  file << std::setw( 2 ) << *this << std::endl;
343  }
344  catch( const std::exception& e )
345  {
346  wxLogTrace( traceSettings, "Warning: could not save %s: %s", GetFullFilename(), e.what() );
347  }
348  catch( ... )
349  {
350  }
351 
352  return true;
353 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
std::string m_filename
The filename (not including path) of this settings file.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
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.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
const char * traceSettings
Flag to enable settings tracing.
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(), and PROJECT_FILE::SaveToFile().

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

136  {
137  ( *this )[PointerFromString( aPath ) ] = aVal;
138  }
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_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 538 of file json_settings.cpp.

539 {
540  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
541 }
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 std::string &  aFilename)
inlineinherited

Definition at line 62 of file json_settings.h.

62 { m_legacy_filename = aFilename; }
std::string m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by LIBEDIT_SETTINGS::LIBEDIT_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 175 of file json_settings.h.

176  {
177  m_manager = aManager;
178  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

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

Returns
true if any part of the JSON document was updated

Definition at line 258 of file json_settings.cpp.

259 {
260  bool modified = false;
261 
262  for( auto param : m_params )
263  {
264  modified |= !param->MatchesFile( this );
265  param->Store( this );
266  }
267 
268  return modified;
269 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings

Definition at line 159 of file app_settings.h.

◆ m_Camera

CAMERA_SETTINGS EDA_3D_VIEWER_SETTINGS::m_Camera

Definition at line 81 of file 3d_viewer_settings.h.

Referenced by EDA_3D_VIEWER_SETTINGS(), and EDA_3D_VIEWER::LoadSettings().

◆ 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 249 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 243 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 255 of file json_settings.h.

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

◆ m_filename

std::string JSON_SETTINGS::m_filename
protectedinherited

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_Graphics

◆ m_legacy_filename

std::string JSON_SETTINGS::m_legacy_filename
protectedinherited

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

Definition at line 231 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_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 234 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 264 of file json_settings.h.

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

◆ m_nested_settings

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

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

Definition at line 240 of file json_settings.h.

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

◆ m_params

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

◆ m_Printing

◆ m_Render

RENDER_SETTINGS EDA_3D_VIEWER_SETTINGS::m_Render

Definition at line 80 of file 3d_viewer_settings.h.

Referenced by EDA_3D_VIEWER_SETTINGS(), and EDA_3D_VIEWER::LoadSettings().

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

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_System

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 252 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().


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