KiCad PCB EDA Suite
PL_EDITOR_SETTINGS Class Reference

#include <pl_editor_settings.h>

Inheritance diagram for PL_EDITOR_SETTINGS:
APP_SETTINGS_BASE JSON_SETTINGS

Public Member Functions

 PL_EDITOR_SETTINGS ()
 
virtual ~PL_EDITOR_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
virtual const std::vector< wxString > DefaultGridSizeList () const
 By default, this returns the list of grids available in PcbNew-based applications. More...
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
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
 
size_t Count (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALSInternals ()
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
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)
 

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

int m_CornerOrigin
 
int m_PropertiesFrameWidth
 
wxString m_LastPaperSize
 
int m_LastCustomWidth
 
int m_LastCustomHeight
 
bool m_LastWasPortrait
 
bool m_BlackBackground
 
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
 

Protected Attributes

wxString m_filename
 The filename (not including path) of this settings file (inicode) More...
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 
std::unique_ptr< JSON_SETTINGS_INTERNALSm_internals
 

Detailed Description

Definition at line 29 of file pl_editor_settings.h.

Constructor & Destructor Documentation

◆ PL_EDITOR_SETTINGS()

PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS ( )

Definition at line 33 of file pl_editor_settings.cpp.

33 :
35{
36 // Make Coverity happy:
39 m_LastCustomWidth = 17000;
40 m_LastCustomHeight = 11000;
41 m_LastWasPortrait = false;
42 m_BlackBackground = false;
43
44 // Build settings:
45 m_params.emplace_back(
46 new PARAM<int>( "properties_frame_width", &m_PropertiesFrameWidth, 150 ) );
47
48 m_params.emplace_back( new PARAM<int>( "corner_origin", &m_CornerOrigin, 0 ) );
49
50 m_params.emplace_back( new PARAM<bool>( "black_background", &m_BlackBackground, false ) );
51
52 m_params.emplace_back( new PARAM<wxString>( "last_paper_size", &m_LastPaperSize, "A3" ) );
53
54 m_params.emplace_back( new PARAM<int>( "last_custom_width", &m_LastCustomWidth, 17000 ) );
55
56 m_params.emplace_back( new PARAM<int>( "last_custom_height", &m_LastCustomHeight, 11000 ) );
57
58 m_params.emplace_back( new PARAM<bool>( "last_was_portrait", &m_LastWasPortrait, false ) );
59}
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
const int plEditorSchemaVersion
! Update the schema version whenever a migration is required

References m_BlackBackground, m_CornerOrigin, m_LastCustomHeight, m_LastCustomWidth, m_LastPaperSize, m_LastWasPortrait, JSON_SETTINGS::m_params, and m_PropertiesFrameWidth.

◆ ~PL_EDITOR_SETTINGS()

virtual PL_EDITOR_SETTINGS::~PL_EDITOR_SETTINGS ( )
inlinevirtual

Definition at line 34 of file pl_editor_settings.h.

34{}

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

744{
745 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
746 m_nested_settings.push_back( aSettings );
747}
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 292 of file app_settings.cpp.

293{
294 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
295 &aWindow->state.maximized, false ) );
296
297 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
298 &aWindow->mru_path, "" ) );
299
300 m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->state.size_x, 0 ) );
301
302 m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->state.size_y, 0 ) );
303
304 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
305 &aWindow->perspective, "" ) );
306
307 m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->state.pos_x, 0 ) );
308
309 m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->state.pos_y, 0 ) );
310
311 m_params.emplace_back( new PARAM<unsigned int>( aJsonPath + ".display", &aWindow->state.display, 0 ) );
312
313 m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
314 &aWindow->zoom_factors, {} ) );
315
316 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
317 &aWindow->grid.axes_enabled, false ) );
318
319 m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
320 &aWindow->grid.sizes, DefaultGridSizeList() ) );
321
322 int defaultGridIdx;
323
324 if( m_filename == "eeschema" || m_filename == "symbol_editor" || m_filename == "pl_editor" )
325 defaultGridIdx = 1;
326 else
327 defaultGridIdx = 4;
328
329 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
330 &aWindow->grid.last_size_idx, defaultGridIdx ) );
331
332 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
333 &aWindow->grid.fast_grid_1, defaultGridIdx ) );
334
335 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
336 &aWindow->grid.fast_grid_2, defaultGridIdx + 1 ) );
337
338 // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
339 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
340 &aWindow->grid.user_grid_x, "10 mil" ) );
341 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
342 &aWindow->grid.user_grid_y, "10 mil" ) );
343
344 m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
345 &aWindow->grid.line_width, 1.0 ) );
346
347 m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
348 &aWindow->grid.min_spacing, 10 ) );
349
350 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
351 &aWindow->grid.show, true ) );
352
353 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
354 &aWindow->grid.style, 0 ) );
355
356 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.snap",
357 &aWindow->grid.snap, 0 ) );
358
359 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
360 &aWindow->cursor.always_show_cursor, true ) );
361
362 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
363 &aWindow->cursor.fullscreen_cursor, false ) );
364}
virtual const std::vector< wxString > DefaultGridSizeList() const
By default, this returns the list of grids available in PcbNew-based applications.
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:89
WINDOW_STATE state
Definition: app_settings.h:84
GRID_SETTINGS grid
Definition: app_settings.h:90
wxString mru_path
Definition: app_settings.h:85
std::vector< double > zoom_factors
Definition: app_settings.h:87
wxString perspective
Definition: app_settings.h:86
unsigned int display
Definition: app_settings.h:76

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

◆ Count()

size_t JSON_SETTINGS::Count ( const std::string &  aPath) const
inherited

◆ DefaultGridSizeList()

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

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

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

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

Definition at line 367 of file app_settings.cpp.

368{
369 return { "1000 mil",
370 "500 mil",
371 "250 mil",
372 "200 mil",
373 "100 mil",
374 "50 mil",
375 "25 mil",
376 "20 mil",
377 "10 mil",
378 "5 mil",
379 "2 mil",
380 "1 mil",
381 "5.0 mm",
382 "2.5 mm",
383 "1.0 mm",
384 "0.5 mm",
385 "0.25 mm",
386 "0.2 mm",
387 "0.1 mm",
388 "0.05 mm",
389 "0.025 mm",
390 "0.01 mm" };
391}

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

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

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

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

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

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

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

774{
775 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
776 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
777
778 return std::nullopt;
779}
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 494 of file json_settings.cpp.

495{
496 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
497 {
498 try
499 {
500 return ret->get<ValueType>();
501 }
502 catch( ... )
503 {
504 }
505 }
506
507 return std::nullopt;
508}

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

272 {
273 return wxT( "json" );
274 }

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

475{
476 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
477
478 if( m_internals->contains( ptr ) )
479 {
480 try
481 {
482 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
483 }
484 catch( ... )
485 {
486 }
487 }
488
489 return std::optional<nlohmann::json>{};
490}

References JSON_SETTINGS::m_internals.

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

277 {
278 return wxEmptyString;
279 }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 39 of file pl_editor_settings.h.

39{ return "PlEditorFrame"; }

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

130{
131 return m_internals.get();
132}

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

136{
137 for( auto param : m_params )
138 {
139 try
140 {
141 param->Load( this, m_resetParamsIfMissing );
142 }
143 catch( ... )
144 {
145 // Skip unreadable parameters in file
146 wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
147 }
148 }
149}
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(), 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 152 of file json_settings.cpp.

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

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

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

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

References JSON_SETTINGS::Set().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool PL_EDITOR_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

Reimplemented from APP_SETTINGS_BASE.

Definition at line 62 of file pl_editor_settings.cpp.

63{
64 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
65
66 ret &= fromLegacy<int>( aCfg, "PropertiesFrameWidth", "properties_frame_width" );
67 ret &= fromLegacy<int>( aCfg, "CornerOriginChoice", "corner_origin" );
68 ret &= fromLegacy<bool>( aCfg, "BlackBgColor", "black_background" );
69 ret &= fromLegacy<int>( aCfg, "LastUsedPaperSize", "last_paper_size" );
70 ret &= fromLegacy<int>( aCfg, "LastUsedCustomWidth", "last_custom_width" );
71 ret &= fromLegacy<int>( aCfg, "LastUsedCustomHeight", "last_custom_height" );
72 ret &= fromLegacy<bool>( aCfg, "LastUsedWasPortrait", "last_was_portrait" );
73
74 return ret;
75}
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.

References APP_SETTINGS_BASE::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 394 of file app_settings.cpp.

395{
396 // We used to store only the width of the first column, because there were only
397 // two possible columns.
398 if( std::optional<int> optWidth = Get<int>( "lib_tree.column_width" ) )
399 {
400 Set<nlohmann::json>( "lib_tree.column_widths", { { "Item", *optWidth } } );
401 At( "lib_tree" ).erase( "column_width" );
402 }
403
404 return true;
405}
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().

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

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

545{
546 wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
547 wxASSERT( aNewSchemaVersion <= m_schemaVersion );
548 m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
549}

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), 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 750 of file json_settings.cpp.

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

368{
369 for( auto param : m_params )
370 param->SetDefault();
371}

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

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

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

525{
526 m_internals->SetFromString( aPath, aVal );
527}

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::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_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

Definition at line 782 of file json_settings.cpp.

783{
784 ( *m_internals )[aPath] = aVal.ToUTF8();
785}

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

611{
612 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
613
614 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
615 {
616 aTarget = aObj.at( ptr ).get<bool>();
617 return true;
618 }
619
620 return false;
621}

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

626{
627 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
628
629 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
630 {
631 aTarget = aObj.at( ptr ).get<int>();
632 return true;
633 }
634
635 return false;
636}

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

641{
642 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
643
644 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
645 {
646 aTarget = aObj.at( ptr ).get<unsigned int>();
647 return true;
648 }
649
650 return false;
651}

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

596{
597 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
598
599 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
600 {
601 aTarget = aObj.at( ptr ).get<wxString>();
602 return true;
603 }
604
605 return false;
606}

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

193 {
194 m_manager = aManager;
195 }

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

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

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 190 of file app_settings.h.

◆ m_BlackBackground

bool PL_EDITOR_SETTINGS::m_BlackBackground

Definition at line 48 of file pl_editor_settings.h.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and PL_EDITOR_SETTINGS().

◆ m_ColorPicker

◆ m_ColorTheme

◆ m_CornerOrigin

int PL_EDITOR_SETTINGS::m_CornerOrigin

Definition at line 42 of file pl_editor_settings.h.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and PL_EDITOR_SETTINGS().

◆ 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 303 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 297 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 309 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_LastCustomHeight

int PL_EDITOR_SETTINGS::m_LastCustomHeight

Definition at line 46 of file pl_editor_settings.h.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and PL_EDITOR_SETTINGS().

◆ m_LastCustomWidth

int PL_EDITOR_SETTINGS::m_LastCustomWidth

Definition at line 45 of file pl_editor_settings.h.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and PL_EDITOR_SETTINGS().

◆ m_LastPaperSize

wxString PL_EDITOR_SETTINGS::m_LastPaperSize

Definition at line 44 of file pl_editor_settings.h.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and PL_EDITOR_SETTINGS().

◆ m_LastWasPortrait

bool PL_EDITOR_SETTINGS::m_LastWasPortrait

Definition at line 47 of file pl_editor_settings.h.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and PL_EDITOR_SETTINGS().

◆ 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 285 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 288 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 318 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 321 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 294 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_PropertiesFrameWidth

int PL_EDITOR_SETTINGS::m_PropertiesFrameWidth

Definition at line 43 of file pl_editor_settings.h.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and PL_EDITOR_SETTINGS().

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

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_System

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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