#include <SettingsWX.h>

Inheritance diagram for SettingsWX:

Collaboration diagram for SettingsWX:

Public Member Functions
	SettingsWX (std::shared_ptr< wxConfigBase > config)

	SettingsWX (const wxString &filepath)
	Constructs BasicSettings object to access BasicSettings stored in the file, using platform-specific format. More...

	~SettingsWX () override

wxString	GetGroup () const override
	Returns current group prefix. More...

wxArrayString	GetChildGroups () const override
	Returns all child groups within the current group. More...

wxArrayString	GetChildKeys () const override
	Returns all child keys within the current group. More...

bool	HasEntry (const wxString &key) const override
	Checks whether specified key exists within the current group. More...

bool	HasGroup (const wxString &key) const override
	Checks whether specified group exists relative to the current group. More...

bool	Remove (const wxString &key) override
	Removes group or entry within the current group, if exists. Pass empty string to remove each entry in the current group. More...

void	Clear () override
	Remove all groups and keys. More...

bool	Read (const wxString &key, bool *value) const override

bool	Read (const wxString &key, int *value) const override

bool	Read (const wxString &key, long *value) const override

bool	Read (const wxString &key, long long *value) const override

bool	Read (const wxString &key, double *value) const override

bool	Read (const wxString &key, wxString *value) const override

bool	Write (const wxString &key, bool value) override

bool	Write (const wxString &key, int value) override

bool	Write (const wxString &key, long value) override

bool	Write (const wxString &key, long long value) override

bool	Write (const wxString &key, double value) override

bool	Write (const wxString &key, const wxString &value) override

bool	Flush () noexcept override

Public Member Functions inherited from audacity::BasicSettings
	BasicSettings ()

virtual	~BasicSettings ()

	BasicSettings (const BasicSettings &)=delete

	BasicSettings (BasicSettings &&)=default

BasicSettings &	operator= (const BasicSettings &)=delete

BasicSettings &	operator= (BasicSettings &&)=default

virtual wxString	GetGroup () const =0
	Returns current group prefix. More...

virtual wxArrayString	GetChildGroups () const =0
	Returns all child groups within the current group. More...

virtual wxArrayString	GetChildKeys () const =0
	Returns all child keys within the current group. More...

virtual bool	HasEntry (const wxString &key) const =0
	Checks whether specified key exists within the current group. More...

virtual bool	HasGroup (const wxString &key) const =0
	Checks whether specified group exists relative to the current group. More...

virtual bool	Exists (const wxString &key) const
	Returns true if group or entry exists. More...

virtual bool	Remove (const wxString &key)=0
	Removes group or entry within the current group, if exists. Pass empty string to remove each entry in the current group. More...

virtual void	Clear ()=0
	Remove all groups and keys. More...

bool	DeleteGroup (const wxString &key)
	Deletes specified group if exists. More...

bool	DeleteEntry (const wxString &key)
	Deletes specified entry if exists. More...

GroupScope	BeginGroup (const wxString &prefix)
	Appends a prefix to the current group or sets a new absolute path. Group that was set as current before `BeginGroup` is called, will be restored once `GroupScope` is destroyed. More...

virtual bool	Read (const wxString &key, bool *value) const =0

virtual bool	Read (const wxString &key, int *value) const =0

virtual bool	Read (const wxString &key, long *value) const =0

virtual bool	Read (const wxString &key, long long *value) const =0

virtual bool	Read (const wxString &key, double *value) const =0

virtual bool	Read (const wxString &key, wxString *value) const =0

virtual bool	Read (const wxString &key, float *value) const

template<typename T >
bool	Read (const wxString &key, T *value) const
	Uses wxFromString to read object. More...

template<typename T >
std::enable_if_t< std::is_scalar_v< T >, bool >	Read (const wxString &key, T *value, T defaultValue) const

template<typename T >
std::enable_if_t<!std::is_scalar_v< T >, bool >	Read (const wxString &key, T *value, const T &defaultValue)

wxString	Read (const wxString &key, const wxString &defaultValue=wxEmptyString) const

wxString	Read (const wxString &key, const char *defaultValue) const

wxString	Read (const wxString &key, const wchar_t *defaultValue) const

template<typename T >
std::enable_if_t< std::is_scalar_v< T >, T >	Read (const wxString &key, T defaultValue) const

template<typename T >
std::enable_if_t<!std::is_scalar_v< T >, T >	Read (const wxString &key, const T &defaultValue) const

virtual bool	Write (const wxString &key, bool value)=0

virtual bool	Write (const wxString &key, int value)=0

virtual bool	Write (const wxString &key, long value)=0

virtual bool	Write (const wxString &key, long long value)=0

virtual bool	Write (const wxString &key, double value)=0

virtual bool	Write (const wxString &key, const wxString &value)=0

virtual bool	Write (const wxString &key, float value)

virtual bool	Write (const wxString &key, const char *value)

virtual bool	Write (const wxString &key, const wchar_t *value)

template<typename T >
bool	Write (const wxString &key, const T &value)
	Uses wxToString to convert object into string. More...

virtual bool	Flush () noexcept=0

bool	ReadBool (const wxString &key, bool defaultValue) const

long	ReadLong (const wxString &key, long defaultValue) const

double	ReadDouble (const wxString &key, double defaultValue) const

template<typename T >
T	ReadObject (const wxString &key, const T &defaultValue) const

Protected Member Functions
void	DoBeginGroup (const wxString &prefix) override

void	DoEndGroup () noexcept override

virtual void	DoBeginGroup (const wxString &prefix)=0

virtual void	DoEndGroup () noexcept=0

Private Member Functions
wxString	MakePath (const wxString &key) const

Private Attributes
wxArrayString	mGroupStack

std::shared_ptr< wxConfigBase >	mConfig

Detailed Description

Definition at line 11 of file SettingsWX.h.

Constructor & Destructor Documentation

◆ SettingsWX() [1/2]

SettingsWX::SettingsWX ( std::shared_ptr< wxConfigBase > config )

explicit

Definition at line 32 of file SettingsWX.cpp.

   : mConfig{std::move(config)}
{
   mGroupStack.push_back("/");
}

References mGroupStack.

◆ SettingsWX() [2/2]

SettingsWX::SettingsWX ( const wxString & filepath )

explicit

Constructs BasicSettings object to access BasicSettings stored in the file, using platform-specific format.

Definition at line 38 of file SettingsWX.cpp.

{
   mConfig = std::make_shared<wxFileConfig>(wxEmptyString, wxEmptyString, filepath);
   mGroupStack.push_back("/");
}

References mConfig, and mGroupStack.

◆ ~SettingsWX()

SettingsWX::~SettingsWX ( )

override

Definition at line 44 of file SettingsWX.cpp.

{
   mConfig->Flush();
}

References mConfig.

Member Function Documentation

◆ Clear()

void SettingsWX::Clear ( )

overridevirtual

Remove all groups and keys.

Implements audacity::BasicSettings.

Definition at line 119 of file SettingsWX.cpp.

{
   mConfig->DeleteAll();
}

References mConfig.

◆ DoBeginGroup()

void SettingsWX::DoBeginGroup ( const wxString & prefix )

overrideprotectedvirtual

Implements audacity::BasicSettings.

Definition at line 7 of file SettingsWX.cpp.

{
   if(prefix.StartsWith("/"))
      mGroupStack.push_back(prefix);
   else
   {
      if(mGroupStack.size() > 1)
         mGroupStack.push_back(mGroupStack.Last() + "/" + prefix);
      else
         mGroupStack.push_back("/" + prefix);
   }
   //This creates group if it didn't exist
   mConfig->SetPath(mGroupStack.Last());
}

References mConfig, and mGroupStack.

◆ DoEndGroup()

void SettingsWX::DoEndGroup ( )

overrideprotectedvirtualnoexcept

Implements audacity::BasicSettings.

Definition at line 22 of file SettingsWX.cpp.

{
   assert(mGroupStack.size() > 1);// "No matching DoBeginGroup"
 
   if(mGroupStack.size() > 1)
      mGroupStack.pop_back();
 
   mConfig->SetPath(mGroupStack.Last());
}

References mConfig, and mGroupStack.

◆ Flush()

bool SettingsWX::Flush ( )

overridevirtualnoexcept

Implements audacity::BasicSettings.

Definition at line 190 of file SettingsWX.cpp.

{
   try
   {
      return mConfig->Flush();
   }
   catch(...)
   {
      //TODO: log error
   }
   return false;
}

References mConfig.

◆ GetChildGroups()

wxArrayString SettingsWX::GetChildGroups ( ) const

overridevirtual

Returns all child groups within the current group.

Implements audacity::BasicSettings.

Definition at line 60 of file SettingsWX.cpp.

{
   long index;
   wxString group;
 
   if(mConfig->GetFirstGroup(group, index))
   {
      wxArrayString groups;
      groups.push_back(group);
      while(mConfig->GetNextGroup(group, index))
         groups.push_back(group);
      return groups;
   }
   return {};
}

References mConfig.

Referenced by Remove().

Here is the caller graph for this function:

◆ GetChildKeys()

wxArrayString SettingsWX::GetChildKeys ( ) const

overridevirtual

Returns all child keys within the current group.

Implements audacity::BasicSettings.

Definition at line 76 of file SettingsWX.cpp.

{
   long index;
   wxString key;
   if(mConfig->GetFirstEntry(key, index))
   {
      wxArrayString keys;
      keys.push_back(key);
      while(mConfig->GetNextEntry(key, index))
         keys.push_back(key);
      return keys;
   }
   return {};
}

References key, and mConfig.

Referenced by Remove().

Here is the caller graph for this function:

◆ GetGroup()

wxString SettingsWX::GetGroup ( ) const

overridevirtual

Returns current group prefix.

Implements audacity::BasicSettings.

Definition at line 49 of file SettingsWX.cpp.

{
   assert(!mGroupStack.empty());
   if(mGroupStack.size() > 1)
   {
      const auto& path = mGroupStack.Last();
      return path.Right(path.Length() - 1);
   }
   return {};
}

References mGroupStack.

◆ HasEntry()

bool SettingsWX::HasEntry ( const wxString & key ) const

overridevirtual

Checks whether specified key exists within the current group.

Implements audacity::BasicSettings.

Definition at line 91 of file SettingsWX.cpp.

{
   return mConfig->HasEntry(MakePath(key));
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ HasGroup()

bool SettingsWX::HasGroup ( const wxString & key ) const

overridevirtual

Checks whether specified group exists relative to the current group.

Implements audacity::BasicSettings.

Definition at line 96 of file SettingsWX.cpp.

{
   return mConfig->HasGroup(MakePath(key));
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ MakePath()

wxString SettingsWX::MakePath ( const wxString & key ) const

private

Definition at line 203 of file SettingsWX.cpp.

{
   if(key.StartsWith("/"))
      return key;
   if(mGroupStack.size() > 1)
      return mGroupStack.Last() + "/" + key;
   return "/" + key;
}

References key, and mGroupStack.

Referenced by HasEntry(), HasGroup(), Read(), Remove(), and Write().

Here is the caller graph for this function:

◆ Read() [1/6]

bool SettingsWX::Read	(	const wxString &	key,
		bool *	value
	)		const

overridevirtual

Implements audacity::BasicSettings.

Definition at line 124 of file SettingsWX.cpp.

{
   return mConfig->Read(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Read() [2/6]

bool SettingsWX::Read	(	const wxString &	key,
		double *	value
	)		const

overridevirtual

Implements audacity::BasicSettings.

Definition at line 150 of file SettingsWX.cpp.

{
   return mConfig->Read(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Read() [3/6]

bool SettingsWX::Read	(	const wxString &	key,
		int *	value
	)		const

overridevirtual

Implements audacity::BasicSettings.

Definition at line 129 of file SettingsWX.cpp.

{
   return mConfig->Read(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Read() [4/6]

bool SettingsWX::Read	(	const wxString &	key,
		long *	value
	)		const

overridevirtual

Implements audacity::BasicSettings.

Definition at line 134 of file SettingsWX.cpp.

{
   return mConfig->Read(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Read() [5/6]

bool SettingsWX::Read	(	const wxString &	key,
		long long *	value
	)		const

overridevirtual

Implements audacity::BasicSettings.

Definition at line 139 of file SettingsWX.cpp.

{
   wxString str;
   if(mConfig->Read(MakePath(key), &str))
   {
      if(str.ToLongLong(value))
         return true;
   }
   return false;
}

References key, MakePath(), mConfig, and str.

Here is the call graph for this function:

◆ Read() [6/6]

bool SettingsWX::Read	(	const wxString &	key,
		wxString *	value
	)		const

overridevirtual

Implements audacity::BasicSettings.

Definition at line 155 of file SettingsWX.cpp.

{
   return mConfig->Read(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Remove()

bool SettingsWX::Remove ( const wxString & key )

overridevirtual

Removes group or entry within the current group, if exists. Pass empty string to remove each entry in the current group.

Implements audacity::BasicSettings.

Definition at line 101 of file SettingsWX.cpp.

{
   if(key.empty())
   {
      for(auto& group : GetChildGroups())
         mConfig->DeleteGroup(group);
      for(auto& entry : GetChildKeys())
         mConfig->DeleteEntry(entry, false);
      return true;
   }
   const auto path = MakePath(key);
   if(mConfig->HasEntry(path))
      return mConfig->DeleteEntry(path, false);
   if(mConfig->HasGroup(path))
      return mConfig->DeleteGroup(path);
   return false;
}

References entry, GetChildGroups(), GetChildKeys(), key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Write() [1/6]

bool SettingsWX::Write	(	const wxString &	key,
		bool	value
	)

overridevirtual

Implements audacity::BasicSettings.

Definition at line 160 of file SettingsWX.cpp.

{
   return mConfig->Write(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Write() [2/6]

bool SettingsWX::Write	(	const wxString &	key,
		const wxString &	value
	)

overridevirtual

Implements audacity::BasicSettings.

Definition at line 185 of file SettingsWX.cpp.

{
   return mConfig->Write(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Write() [3/6]

bool SettingsWX::Write	(	const wxString &	key,
		double	value
	)

overridevirtual

Implements audacity::BasicSettings.

Definition at line 180 of file SettingsWX.cpp.

{
   return mConfig->Write(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Write() [4/6]

bool SettingsWX::Write	(	const wxString &	key,
		int	value
	)

overridevirtual

Implements audacity::BasicSettings.

Definition at line 165 of file SettingsWX.cpp.

{
   return mConfig->Write(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Write() [5/6]

bool SettingsWX::Write	(	const wxString &	key,
		long long	value
	)

overridevirtual

Implements audacity::BasicSettings.

Definition at line 175 of file SettingsWX.cpp.

{
   return mConfig->Write(MakePath(key), wxString::Format("%lld", value));
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

◆ Write() [6/6]

bool SettingsWX::Write	(	const wxString &	key,
		long	value
	)

overridevirtual

Implements audacity::BasicSettings.

Definition at line 170 of file SettingsWX.cpp.

{
   return mConfig->Write(MakePath(key), value);
}

References key, MakePath(), and mConfig.

Here is the call graph for this function:

Member Data Documentation

◆ mConfig

std::shared_ptr<wxConfigBase> SettingsWX::mConfig

private

Definition at line 14 of file SettingsWX.h.

Referenced by Clear(), DoBeginGroup(), DoEndGroup(), Flush(), GetChildGroups(), GetChildKeys(), HasEntry(), HasGroup(), Read(), Remove(), SettingsWX(), Write(), and ~SettingsWX().

◆ mGroupStack

wxArrayString SettingsWX::mGroupStack

private

Definition at line 13 of file SettingsWX.h.

Referenced by DoBeginGroup(), DoEndGroup(), GetGroup(), MakePath(), and SettingsWX().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SettingsWX() [1/2]

◆ SettingsWX() [2/2]

◆ ~SettingsWX()

Member Function Documentation

◆ Clear()

◆ DoBeginGroup()

◆ DoEndGroup()

◆ Flush()

◆ GetChildGroups()

◆ GetChildKeys()

◆ GetGroup()

◆ HasEntry()

◆ HasGroup()

◆ MakePath()

◆ Read() [1/6]

◆ Read() [2/6]

◆ Read() [3/6]

◆ Read() [4/6]

◆ Read() [5/6]

◆ Read() [6/6]

◆ Remove()

◆ Write() [1/6]

◆ Write() [2/6]

◆ Write() [3/6]

◆ Write() [4/6]

◆ Write() [5/6]

◆ Write() [6/6]

Member Data Documentation

◆ mConfig

◆ mGroupStack