CommandParameters Class Reference

CommandParameters, derived from wxFileConfig, is essentially doing the same things as the SettingsVisitor classes. It does text <-> binary conversions of parameters. It does not seem to be using actual file read/writing.
More...

#include <EffectAutomationParameters.h>

Inheritance diagram for CommandParameters:

Collaboration diagram for CommandParameters:

Public Types
using	ObsoleteMap = std::pair< wxString, size_t >

Public Member Functions
	CommandParameters (const wxString &parms={})
virtual	~CommandParameters ()
virtual bool	HasGroup (const wxString &strName) const override
virtual bool	HasEntry (const wxString &strName) const override
virtual bool	DoReadString (const wxString &key, wxString *pStr) const override
virtual bool	DoReadLong (const wxString &key, long *pl) const override
virtual bool	DoReadDouble (const wxString &key, double *pd) const override
virtual bool	DoWriteString (const wxString &key, const wxString &szValue) override
virtual bool	DoWriteLong (const wxString &key, long lValue) override
virtual bool	DoWriteDouble (const wxString &key, double value) override
bool	ReadFloat (const wxString &key, float *pf) const
bool	ReadFloat (const wxString &key, float *pf, float defVal) const
bool	WriteFloat (const wxString &key, float f)
bool	ReadEnum (const wxString &key, int *pi, const EnumValueSymbol choices[], size_t nChoices, const ObsoleteMap obsoletes[]=nullptr, size_t nObsoletes=0) const
bool	ReadEnum (const wxString &key, int *pi, int defVal, const EnumValueSymbol choices[], size_t nChoices, const ObsoleteMap obsoletes[]=nullptr, size_t nObsoletes=0) const
bool	WriteEnum (const wxString &key, int value, const EnumValueSymbol choices[], size_t nChoices)
bool	ReadAndVerify (const wxString &key, float *val, float defVal, float min, float max) const
bool	ReadAndVerify (const wxString &key, double *val, double defVal, double min, double max) const
bool	ReadAndVerify (const wxString &key, int *val, int defVal, int min, int max) const
bool	ReadAndVerify (const wxString &key, long *val, long defVal, long min, long max) const
bool	ReadAndVerify (const wxString &key, bool *val, bool defVal, bool=false, bool=false) const
bool	ReadAndVerify (const wxString &key, wxString *val, const wxString &defVal, const wxString &={}, const wxString &={}) const
bool	ReadAndVerify (const wxString &key, int *val, int defVal, const EnumValueSymbol choices[], size_t nChoices, const ObsoleteMap obsoletes[]=nullptr, size_t nObsoletes=0) const
bool	GetParameters (wxString &parms)
bool	SetParameters (const wxString &parms)
wxString	Escape (wxString val)
wxString	Unescape (wxString val)

Static Public Member Functions
static wxString	NormalizeName (const wxString &name)

Detailed Description

CommandParameters, derived from wxFileConfig, is essentially doing the same things as the SettingsVisitor classes. It does text <-> binary conversions of parameters. It does not seem to be using actual file read/writing.

Should it be converted to using SettingsVisitor? Probably yes. SettingsVisitor leads to shorter code. And SettingsVisitor is more multi-functional since SettingsVisitor can report on signature, do the work of wxWidget validators, and can create default dialogs. However until that conversion is done, we need this class, and we use a pointer to one from within a SettingsVisitor when interfacing with the code that still uses it.

Definition at line 66 of file EffectAutomationParameters.h.

Member Typedef Documentation

ObsoleteMap

using CommandParameters::ObsoleteMap = std::pair< wxString, size_t >

Definition at line 163 of file EffectAutomationParameters.h.

Constructor & Destructor Documentation

CommandParameters()

CommandParameters::CommandParameters ( const wxString &  parms = {} )

inline

Definition at line 69 of file EffectAutomationParameters.h.

                                              {})
   :  wxFileConfig(wxEmptyString,
                   wxEmptyString,
                   wxEmptyString,
                   wxEmptyString,
                   0)
   {
      SetExpandEnvVars(false);
      SetParameters(parms);
   }

~CommandParameters()

CommandParameters::~CommandParameters ( )

virtualdefault

Member Function Documentation

DoReadDouble()

virtual bool CommandParameters::DoReadDouble ( const wxString &  key, double *  pd  ) const

inlineoverridevirtual

Definition at line 102 of file EffectAutomationParameters.h.

   {
      wxString str;
      if (Read(key, &str))
      {
         struct lconv *info = localeconv();
         wxString dec =
            info ? wxString::FromUTF8(info->decimal_point) : wxString(".");
 
         str.Replace(wxT(","), dec);
         str.Replace(wxT("."), dec);
 
         return str.ToDouble(pd);
      }
 
      return false;
   }

References key, str, and wxT().

Here is the call graph for this function:

DoReadLong()

virtual bool CommandParameters::DoReadLong ( const wxString &  key, long *  pl  ) const

inlineoverridevirtual

Definition at line 97 of file EffectAutomationParameters.h.

   {
      return wxFileConfig::DoReadLong(NormalizeName(key), pl);
   }

References key.

DoReadString()

virtual bool CommandParameters::DoReadString ( const wxString &  key, wxString *  pStr  ) const

inlineoverridevirtual

Definition at line 92 of file EffectAutomationParameters.h.

   {
      return wxFileConfig::DoReadString(NormalizeName(key), pStr);
   }

References key.

DoWriteDouble()

virtual bool CommandParameters::DoWriteDouble ( const wxString &  key, double  value  )

inlineoverridevirtual

Definition at line 130 of file EffectAutomationParameters.h.

   {
      return DoWriteString(key, wxString::Format(wxT("%.8g"), value));
   }

References key, and wxT().

Here is the call graph for this function:

DoWriteLong()

virtual bool CommandParameters::DoWriteLong ( const wxString &  key, long  lValue  )

inlineoverridevirtual

Definition at line 125 of file EffectAutomationParameters.h.

   {
      return wxFileConfig::DoWriteLong(NormalizeName(key), lValue);
   }

References key.

DoWriteString()

virtual bool CommandParameters::DoWriteString ( const wxString &  key, const wxString &  szValue  )

inlineoverridevirtual

Definition at line 120 of file EffectAutomationParameters.h.

   {
      return wxFileConfig::DoWriteString(NormalizeName(key), szValue);
   }

References key.

Escape()

wxString CommandParameters::Escape ( wxString  val )

inline

Definition at line 321 of file EffectAutomationParameters.h.

   {
      val.Replace(wxT("\\"), wxT("\\\\"), true);
      val.Replace(wxT("\""), wxT("\\\""), true);
      val.Replace(wxT("\n"), wxT("\\n"), true);
 
      return val;
   }

References wxT().

Here is the call graph for this function:

GetParameters()

bool CommandParameters::GetParameters ( wxString &  parms )

inline

Definition at line 259 of file EffectAutomationParameters.h.

   {
      wxFileConfig::SetPath(wxT("/"));
 
      wxString str;
      wxString key;
 
      long ndx = 0;
      bool res = wxFileConfig::GetFirstEntry(key, ndx);
      while (res)
      {
         wxString val;
         if (!wxFileConfig::Read(key, &val))
         {
            return false;
         }
 
         str += key + wxT("=\"") + Escape(val) + wxT("\" ");
 
         res = wxFileConfig::GetNextEntry(key, ndx);
      }
      str.Trim();
 
      parms = str;
 
      return true;
   }

References key, str, and wxT().

Referenced by EVT_COMMAND_RANGE(), EffectManager::GetDefaultPreset(), EffectManager::GetPreset(), LadspaEffectBase::SaveParameters(), LV2EffectBase::SaveParameters(), Effect::SaveSettingsAsString(), AudacityCommand::SaveSettingsAsString(), and VSTEffectBase::SaveUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

HasEntry()

virtual bool CommandParameters::HasEntry ( const wxString &  strName ) const

inlineoverridevirtual

Definition at line 87 of file EffectAutomationParameters.h.

   {
      return wxFileConfig::HasEntry(NormalizeName(strName));
   }

Referenced by ShuttleSetAutomation::CouldGet(), EffectManager::GetPreset(), VST3Wrapper::LoadSettings(), and EffectAndCommandPluginManager::SetEffectParameters().

Here is the caller graph for this function:

HasGroup()

virtual bool CommandParameters::HasGroup ( const wxString &  strName ) const

inlineoverridevirtual

Definition at line 82 of file EffectAutomationParameters.h.

   {
      return wxFileConfig::HasGroup(NormalizeName(strName));
   }

NormalizeName()

static wxString CommandParameters::NormalizeName ( const wxString &  name )

inlinestatic

Definition at line 307 of file EffectAutomationParameters.h.

   {
      wxString cleaned = name;
 
      cleaned.Trim(true).Trim(false);
      cleaned.Replace(wxT(" "), wxT("_"));
      cleaned.Replace(wxT("/"), wxT("_"));
      cleaned.Replace(wxT("\\"), wxT("_"));
      cleaned.Replace(wxT(":"), wxT("_"));
      cleaned.Replace(wxT("="), wxT("_"));
 
      return cleaned;
   }

References name, and wxT().

Referenced by VSTWrapper::ForEachParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadAndVerify() [1/7]

bool CommandParameters::ReadAndVerify ( const wxString &  key, bool *  val, bool  defVal, bool  = false, bool  = false  ) const

inline

Definition at line 237 of file EffectAutomationParameters.h.

   {
      Read(key, val, defVal);
      return true;
   }

References key.

ReadAndVerify() [2/7]

bool CommandParameters::ReadAndVerify ( const wxString &  key, double *  val, double  defVal, double  min, double  max  ) const

inline

Definition at line 219 of file EffectAutomationParameters.h.

   {
      Read(key, val, defVal);
      return (*val >= min && *val <= max);
   }

References key, and min().

Here is the call graph for this function:

ReadAndVerify() [3/7]

bool CommandParameters::ReadAndVerify ( const wxString &  key, float *  val, float  defVal, float  min, float  max  ) const

inline

Definition at line 213 of file EffectAutomationParameters.h.

   {
      ReadFloat(key, val, defVal);
      return (*val >= min && *val <= max);
   }

References key, and min().

Referenced by ShuttleSetAutomation::Define(), ShuttleSetAutomation::DefineEnum(), TruncSilenceBase::LoadSettings(), and CapturedParameters< EffectType, Parameters >::SetOne().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadAndVerify() [4/7]

bool CommandParameters::ReadAndVerify ( const wxString &  key, int *  val, int  defVal, const EnumValueSymbol  choices[], size_t  nChoices, const ObsoleteMap  obsoletes[] = nullptr, size_t  nObsoletes = 0  ) const

inline

Definition at line 250 of file EffectAutomationParameters.h.

   {
      ReadEnum(key, val, defVal, choices, nChoices, obsoletes, nObsoletes);
      return (*val != wxNOT_FOUND);
   }

References key.

ReadAndVerify() [5/7]

bool CommandParameters::ReadAndVerify ( const wxString &  key, int *  val, int  defVal, int  min, int  max  ) const

inline

Definition at line 225 of file EffectAutomationParameters.h.

   {
      Read(key, val, defVal);
      return (*val >= min && *val <= max);
   }

References key, and min().

Here is the call graph for this function:

ReadAndVerify() [6/7]

bool CommandParameters::ReadAndVerify ( const wxString &  key, long *  val, long  defVal, long  min, long  max  ) const

inline

Definition at line 231 of file EffectAutomationParameters.h.

   {
      Read(key, val, defVal);
      return (*val >= min && *val <= max);
   }

References key, and min().

Here is the call graph for this function:

ReadAndVerify() [7/7]

bool CommandParameters::ReadAndVerify ( const wxString &  key, wxString *  val, const wxString &  defVal, const wxString &  = {}, const wxString &  = {}  ) const

inline

Definition at line 243 of file EffectAutomationParameters.h.

                        {}, const wxString& = {} ) const
   {
      Read(key, val, defVal);
      return true;
   }

ReadEnum() [1/2]

bool CommandParameters::ReadEnum ( const wxString &  key, int *  pi, const EnumValueSymbol  choices[], size_t  nChoices, const ObsoleteMap  obsoletes[] = nullptr, size_t  nObsoletes = 0  ) const

inline

Definition at line 165 of file EffectAutomationParameters.h.

   {
      wxString s;
      if (!wxFileConfig::Read(key, &s))
      {
         return false;
      }
      *pi = std::find( choices, choices + nChoices,
                       EnumValueSymbol{ s, {} } ) - choices;
      if (*pi == (int)nChoices)
         *pi = -1;
      if (*pi < 0 && obsoletes) {
         auto index = std::find_if(obsoletes, obsoletes + nObsoletes,
                                   [&](const ObsoleteMap &entry){
                                      return entry.first == s; })
            - obsoletes;
         if (index < (int)nObsoletes)
            *pi = (int)obsoletes[index].second;
      }
      return true;
   }

References entry, key, and MIR::anonymous_namespace{MirUtils.cpp}::pi.

Referenced by VampEffect::LoadSettings(), and NyquistBase::SetLispVarsFromParameters().

Here is the caller graph for this function:

ReadEnum() [2/2]

bool CommandParameters::ReadEnum ( const wxString &  key, int *  pi, int  defVal, const EnumValueSymbol  choices[], size_t  nChoices, const ObsoleteMap  obsoletes[] = nullptr, size_t  nObsoletes = 0  ) const

inline

Definition at line 190 of file EffectAutomationParameters.h.

   {
      if (!ReadEnum(key, pi, choices, nChoices, obsoletes, nObsoletes))
      {
         *pi = defVal;
      }
      return true;
   }

References key, and MIR::anonymous_namespace{MirUtils.cpp}::pi.

ReadFloat() [1/2]

bool CommandParameters::ReadFloat ( const wxString &  key, float *  pf  ) const

inline

Definition at line 135 of file EffectAutomationParameters.h.

   {
      double d = *pf;
      bool success = Read(key, &d);
      if (success)
      {
         *pf = (float) d;
      }
      return success;
   }

References key.

ReadFloat() [2/2]

bool CommandParameters::ReadFloat ( const wxString &  key, float *  pf, float  defVal  ) const

inline

Definition at line 146 of file EffectAutomationParameters.h.

   {
      if (!ReadFloat(key, pf))
      {
         *pf = defVal;
      }
      return true;
   }

References key.

SetParameters()

bool CommandParameters::SetParameters ( const wxString &  parms )

inline

Definition at line 287 of file EffectAutomationParameters.h.

   {
      wxFileConfig::SetPath(wxT("/"));
 
      auto parsed = wxCmdLineParser::ConvertStringToArgs(parms);
 
      for (size_t i = 0, cnt = parsed.size(); i < cnt; i++)
      {
         wxString key = parsed[i].BeforeFirst(wxT('=')).Trim(false).Trim(true);
         wxString val = parsed[i].AfterFirst(wxT('=')).Trim(false).Trim(true);
 
         if (!wxFileConfig::Write(key, Unescape(val)))
         {
            return false;
         }
      }
 
      return true;
   }

References key, and wxT().

Referenced by NyquistBase::DoLoadSettings(), EVT_COMMAND_RANGE(), LadspaEffectBase::LoadParameters(), LV2EffectBase::LoadParameters(), VSTEffectBase::LoadUserPreset(), and AudioUnitEffectBase::MigrateOldConfigFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Unescape()

wxString CommandParameters::Unescape ( wxString  val )

inline

Definition at line 330 of file EffectAutomationParameters.h.

   {
      val.Replace(wxT("\\n"), wxT("\n"), true);
      val.Replace(wxT("\\\""), wxT("\""), true);
      val.Replace(wxT("\\\\"), wxT("\\"), true);
 
      return val;
   }

References wxT().

Here is the call graph for this function:

WriteEnum()

bool CommandParameters::WriteEnum ( const wxString &  key, int  value, const EnumValueSymbol  choices[], size_t  nChoices  )

inline

Definition at line 202 of file EffectAutomationParameters.h.

   {
      if (value < 0 || value >= (int)nChoices)
      {
         return false;
      }
 
      return wxFileConfig::Write(key, choices[value].Internal());
   }

References Internal, and key.

Referenced by NyquistBase::SaveSettings(), and VampEffect::SaveSettings().

Here is the caller graph for this function:

WriteFloat()

bool CommandParameters::WriteFloat ( const wxString &  key, float  f  )

inline

Definition at line 155 of file EffectAutomationParameters.h.

   {
      return Write(key, f);
   }

References key.

Referenced by ShuttleGetAutomation::Define().

Here is the caller graph for this function:

---

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

• EffectAutomationParameters.h
• EffectAutomationParameters.cpp