Represents a list of strings holding directory paths. More...

#include <parameters.h>

Inheritance diagram for PARAM_PATH_LIST:

Public Member Functions
	PARAM_PATH_LIST (const std::string &aJsonPath, std::vector< wxString > *aPtr, std::initializer_list< wxString > aDefault)

	PARAM_PATH_LIST (const std::string &aJsonPath, std::vector< wxString > *aPtr, std::vector< wxString > aDefault)

void	Load (const JSON_SETTINGS &aSettings, bool aResetIfMissing=true) const override
	Loads the value of this parameter from JSON to the underlying storage.

void	Store (JSON_SETTINGS *aSettings) const override
	Stores the value of this parameter to the given JSON_SETTINGS object.

bool	MatchesFile (const JSON_SETTINGS &aSettings) const override
	Checks whether persisting the parameter would leave the file unchanged.

void	SetDefault () override

const std::string &	GetJsonPath () const

bool	ClearUnknownKeys () const

void	SetClearUnknownKeys (bool aSet=true)

Protected Attributes
std::vector< wxString > *	m_ptr

std::vector< wxString >	m_default

bool	m_resetIfEmpty

std::string	m_path
	Address of the param in the json files.

bool	m_readOnly
	Indicates param pointer should never be overwritten.

bool	m_clearUnknownKeys
	Keys should be cleared from source rather than merged.

Private Member Functions
wxString	toFileFormat (const wxString &aString) const

wxString	fromFileFormat (const wxString &aString) const

Detailed Description

Represents a list of strings holding directory paths.

Normalizes paths to unix directory separator style in the file.

Definition at line 692 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_PATH_LIST() [1/2]

PARAM_PATH_LIST::PARAM_PATH_LIST	(	const std::string &	aJsonPath,
		std::vector< wxString > *	aPtr,
		std::initializer_list< wxString >	aDefault )

inline

Definition at line 695 of file parameters.h.

References PARAM_LIST< wxString >::PARAM_LIST().

◆ PARAM_PATH_LIST() [2/2]

PARAM_PATH_LIST::PARAM_PATH_LIST	(	const std::string &	aJsonPath,
		std::vector< wxString > *	aPtr,
		std::vector< wxString >	aDefault )

inline

Definition at line 700 of file parameters.h.

References PARAM_LIST< wxString >::PARAM_LIST().

Member Function Documentation

◆ ClearUnknownKeys()

bool PARAM_BASE::ClearUnknownKeys ( ) const

inlineinherited

Returns: true if keys should be cleared from source file rather than merged. Useful for things such as text variables that are semantically an array but stored as a map.

Definition at line 81 of file parameters.h.

◆ fromFileFormat()

wxString PARAM_PATH_LIST::fromFileFormat ( const wxString & aString ) const

inlineprivate

Definition at line 728 of file parameters.h.

Referenced by Load(), and MatchesFile().

◆ 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 75 of file parameters.h.

◆ Load()

void PARAM_PATH_LIST::Load	(	const JSON_SETTINGS &	aSettings,
		bool	aResetIfMissing = true ) const

inlineoverridevirtual

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

Parameters

aSettings	is the JSON_SETTINGS object to load from.
aResetIfMissing	if true will set the parameter to its default value if load fails

Reimplemented from PARAM_LIST< wxString >.

Definition at line 705 of file parameters.h.

References fromFileFormat(), PARAM_LIST< Type >::Load(), PARAM_LIST< wxString >::m_ptr, and PARAM_LIST< wxString >::m_readOnly.

◆ MatchesFile()

bool PARAM_PATH_LIST::MatchesFile ( const JSON_SETTINGS & aSettings ) const

overridevirtual

Checks whether persisting the parameter would leave the file unchanged.

When the settings reset absent params on load, a parameter the file omits but which still holds its default counts as a match, so unchanged projects are not rewritten with redundant default keys.

Parameters

aSettings is a JSON_SETTINGS to check the JSON file contents of

Returns: true if the parameter in memory matches its value in the file, or is absent and default

Reimplemented from PARAM_LIST< wxString >.

Definition at line 39 of file parameters.cpp.

References fromFileFormat(), JSON_SETTINGS::GetJson(), PARAM_LIST< wxString >::m_default, PARAM_LIST< wxString >::m_path, PARAM_LIST< wxString >::m_ptr, and JSON_SETTINGS::ResetsParamsIfMissing().

◆ SetClearUnknownKeys()

void PARAM_BASE::SetClearUnknownKeys ( bool aSet = true )

inlineinherited

Definition at line 83 of file parameters.h.

◆ SetDefault()

void PARAM_LIST< wxString >::SetDefault ( )

inlineoverridevirtualinherited

Implements PARAM_BASE.

Definition at line 548 of file parameters.h.

◆ Store()

void PARAM_PATH_LIST::Store ( JSON_SETTINGS * aSettings ) const

overridevirtual

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

Parameters

aSettings is the JSON_SETTINGS object to store into.

Reimplemented from PARAM_LIST< wxString >.

Definition at line 28 of file parameters.cpp.

References PARAM_LIST< wxString >::m_path, PARAM_LIST< wxString >::m_ptr, JSON_SETTINGS::Set(), and toFileFormat().

◆ toFileFormat()

wxString PARAM_PATH_LIST::toFileFormat ( const wxString & aString ) const

inlineprivate

Definition at line 721 of file parameters.h.

Referenced by Store().

Member Data Documentation

◆ m_clearUnknownKeys

bool PARAM_BASE::m_clearUnknownKeys

protectedinherited

Keys should be cleared from source rather than merged.

This is useful for things that are semantically an array but stored as a map, such as textVars.

Definition at line 88 of file parameters.h.

◆ m_default

std::vector<wxString> PARAM_LIST< wxString >::m_default

protectedinherited

Definition at line 582 of file parameters.h.

Referenced by PARAM_PATH_LIST::MatchesFile().

◆ m_path

std::string PARAM_BASE::m_path

protectedinherited

Address of the param in the json files.

Definition at line 86 of file parameters.h.

Referenced by PARAM_PATH_LIST::MatchesFile(), and PARAM_PATH_LIST::Store().

◆ m_ptr

std::vector<wxString>* PARAM_LIST< wxString >::m_ptr

protectedinherited

Definition at line 581 of file parameters.h.

Referenced by PARAM_PATH_LIST::Load(), PARAM_PATH_LIST::MatchesFile(), and PARAM_PATH_LIST::Store().

◆ m_readOnly

bool PARAM_BASE::m_readOnly

protectedinherited

Indicates param pointer should never be overwritten.

Definition at line 87 of file parameters.h.

Referenced by PARAM_PATH_LIST::Load().

◆ m_resetIfEmpty

bool PARAM_LIST< wxString >::m_resetIfEmpty

protectedinherited

Definition at line 583 of file parameters.h.

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PARAM_PATH_LIST() [1/2]

◆ PARAM_PATH_LIST() [2/2]

Member Function Documentation

◆ ClearUnknownKeys()

◆ fromFileFormat()

◆ GetJsonPath()

◆ Load()

◆ MatchesFile()

◆ SetClearUnknownKeys()

◆ SetDefault()

◆ Store()

◆ toFileFormat()

Member Data Documentation

◆ m_clearUnknownKeys

◆ m_default

◆ m_path

◆ m_ptr

◆ m_readOnly

◆ m_resetIfEmpty