KiCad PCB EDA Suite
PARAM_WXSTRING_MAP Class Reference

A helper for <wxString, wxString> maps. More...

#include <parameters.h>

Inheritance diagram for PARAM_WXSTRING_MAP:
PARAM_BASE

Public Member Functions

 PARAM_WXSTRING_MAP (const std::string &aJsonPath, std::map< wxString, wxString > *aPtr, std::initializer_list< std::pair< const wxString, wxString > > aDefault, bool aReadOnly=false)
 
void Load (JSON_SETTINGS *aSettings, bool aResetIfMissing=true) const override
 Loads the value of this parameter from JSON to the underlying storage. More...
 
void Store (JSON_SETTINGS *aSettings) const override
 Stores the value of this parameter to the given JSON_SETTINGS object. More...
 
virtual void SetDefault () override
 
bool MatchesFile (JSON_SETTINGS *aSettings) const override
 Checks whether the parameter in memory matches the one in a given JSON file. More...
 
const std::string & GetJsonPath () const
 

Protected Attributes

std::string m_path
 the string used to store the param in json files More...
 
bool m_readOnly
 ! True if the parameter pointer should never be overwritten More...
 

Private Attributes

std::map< wxString, wxString > * m_ptr
 
std::map< wxString, wxString > m_default
 

Detailed Description

A helper for <wxString, wxString> maps.

Definition at line 579 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_WXSTRING_MAP()

PARAM_WXSTRING_MAP::PARAM_WXSTRING_MAP ( const std::string &  aJsonPath,
std::map< wxString, wxString > *  aPtr,
std::initializer_list< std::pair< const wxString, wxString > >  aDefault,
bool  aReadOnly = false 
)
inline

Definition at line 582 of file parameters.h.

584 :
585 PARAM_BASE( aJsonPath, aReadOnly ),
586 m_ptr( aPtr ),
587 m_default( aDefault )
588 { }
PARAM_BASE(std::string aJsonPath, bool aReadOnly)
Definition: parameters.h:36
std::map< wxString, wxString > * m_ptr
Definition: parameters.h:602
std::map< wxString, wxString > m_default
Definition: parameters.h:604

Member Function Documentation

◆ GetJsonPath()

const std::string & PARAM_BASE::GetJsonPath ( ) const
inlineinherited
Returns
the path name of the parameter used to store it in the json file mainly useful in error messages

Definition at line 69 of file parameters.h.

69{ return m_path; }
std::string m_path
the string used to store the param in json files
Definition: parameters.h:75

References PARAM_BASE::m_path.

◆ Load()

void PARAM_WXSTRING_MAP::Load ( JSON_SETTINGS aSettings,
bool  aResetIfMissing = true 
) const
overridevirtual

Loads the value of this parameter from JSON to the underlying storage.

Parameters
aSettingsis the JSON_SETTINGS object to load from.
aResetIfMissingif true will set the parameter to its default value if load fails

Implements PARAM_BASE.

Definition at line 290 of file parameters.cpp.

291{
292 if( m_readOnly )
293 return;
294
295 if( std::optional<nlohmann::json> js = aSettings->GetJson( m_path ) )
296 {
297 if( js->is_object() )
298 {
299 m_ptr->clear();
300
301 for( const auto& el : js->items() )
302 {
303 ( *m_ptr )[wxString( el.key().c_str(), wxConvUTF8 )] = el.value().get<wxString>();
304 }
305 }
306 }
307 else if( aResetIfMissing )
308 *m_ptr = m_default;
309}
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....
bool m_readOnly
! True if the parameter pointer should never be overwritten
Definition: parameters.h:78

References PARAM_BASE::m_readOnly.

◆ MatchesFile()

bool PARAM_WXSTRING_MAP::MatchesFile ( JSON_SETTINGS aSettings) const
overridevirtual

Checks whether the parameter in memory matches the one in a given JSON file.

Parameters
aSettingsis a JSON_SETTINGS to check the JSON file contents of
Returns
true if the parameter in memory matches its value in the file

Implements PARAM_BASE.

Definition at line 326 of file parameters.cpp.

327{
328 if( std::optional<nlohmann::json> js = aSettings->GetJson( m_path ) )
329 {
330 if( js->is_object() )
331 {
332 if( m_ptr->size() != js->size() )
333 return false;
334
335 std::map<wxString, wxString> val;
336
337 for( const auto& el : js->items() )
338 {
339 wxString key( el.key().c_str(), wxConvUTF8 );
340 val[key] = el.value().get<wxString>();
341 }
342
343 return val == *m_ptr;
344 }
345 }
346
347 return false;
348}

References JSON_SETTINGS::GetJson(), PARAM_BASE::m_path, and m_ptr.

◆ SetDefault()

virtual void PARAM_WXSTRING_MAP::SetDefault ( )
inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 594 of file parameters.h.

595 {
596 *m_ptr = m_default;
597 }

References m_default, and m_ptr.

◆ Store()

void PARAM_WXSTRING_MAP::Store ( JSON_SETTINGS aSettings) const
overridevirtual

Stores the value of this parameter to the given JSON_SETTINGS object.

Parameters
aSettingsis the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Definition at line 312 of file parameters.cpp.

313{
314 nlohmann::json js( {} );
315
316 for( const auto& el : *m_ptr )
317 {
318 std::string key( el.first.ToUTF8() );
319 js[key] = el.second;
320 }
321
322 aSettings->Set<nlohmann::json>( m_path, js );
323}
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
nlohmann::json json
Definition: gerbview.cpp:44

Member Data Documentation

◆ m_default

std::map<wxString, wxString> PARAM_WXSTRING_MAP::m_default
private

Definition at line 604 of file parameters.h.

Referenced by SetDefault().

◆ m_path

◆ m_ptr

std::map<wxString, wxString>* PARAM_WXSTRING_MAP::m_ptr
private

Definition at line 602 of file parameters.h.

Referenced by PARAM_LAMBDA< nlohmann::json >::Load(), MatchesFile(), and SetDefault().

◆ m_readOnly

bool PARAM_BASE::m_readOnly
protectedinherited

! True if the parameter pointer should never be overwritten

Definition at line 78 of file parameters.h.

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


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