FileConfig Class Reference

#include <FileConfig.h>

Inheritance diagram for FileConfig:

Collaboration diagram for FileConfig:

Public Member Functions
	FileConfig (const wxString &appName=wxEmptyString, const wxString &vendorName=wxEmptyString, const wxString &localFilename=wxEmptyString, const wxString &globalFilename=wxEmptyString, long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE, const wxMBConv &conv=wxConvAuto())
void	Init ()
virtual	~FileConfig ()
virtual void	SetPath (const wxString &strPath) wxOVERRIDE
virtual const wxString &	GetPath () const wxOVERRIDE
virtual bool	GetFirstGroup (wxString &str, long &lIndex) const wxOVERRIDE
virtual bool	GetNextGroup (wxString &str, long &lIndex) const wxOVERRIDE
virtual bool	GetFirstEntry (wxString &str, long &lIndex) const wxOVERRIDE
virtual bool	GetNextEntry (wxString &str, long &lIndex) const wxOVERRIDE
virtual size_t	GetNumberOfEntries (bool bRecursive=false) const wxOVERRIDE
virtual size_t	GetNumberOfGroups (bool bRecursive=false) const wxOVERRIDE
virtual bool	HasGroup (const wxString &strName) const wxOVERRIDE
virtual bool	HasEntry (const wxString &strName) const wxOVERRIDE
virtual bool	Flush (bool bCurrentOnly=false) wxOVERRIDE
virtual bool	RenameEntry (const wxString &oldName, const wxString &newName) wxOVERRIDE
virtual bool	RenameGroup (const wxString &oldName, const wxString &newName) wxOVERRIDE
virtual bool	DeleteEntry (const wxString &key, bool bDeleteGroupIfEmpty=true) wxOVERRIDE
virtual bool	DeleteGroup (const wxString &key) wxOVERRIDE
virtual bool	DeleteAll () wxOVERRIDE
void	SetVersionKeysInit (int major, int minor, int micro)
void	GetVersionKeysInit (int &major, int &minor, int &micro) const

Protected Member Functions
virtual bool	DoReadString (const wxString &key, wxString *pStr) const wxOVERRIDE
virtual bool	DoReadLong (const wxString &key, long *pl) const wxOVERRIDE
virtual bool	DoWriteString (const wxString &key, const wxString &szValue) wxOVERRIDE
virtual bool	DoWriteLong (const wxString &key, long lValue) wxOVERRIDE
virtual void	Warn ()
const FilePath &	GetFilePath () const

Private Attributes
const wxString	mAppName
const wxString	mVendorName
const wxString	mLocalFilename
const wxString	mGlobalFilename
const long	mStyle
std::unique_ptr< wxMBConv >	mConv
std::unique_ptr< wxFileConfig >	mConfig
int	mVersionMajorKeyInit {}
int	mVersionMinorKeyInit {}
int	mVersionMicroKeyInit {}
bool	mDirty

Detailed Description

Definition at line 20 of file FileConfig.h.

Constructor & Destructor Documentation

FileConfig()

FileConfig::FileConfig	(	const wxString &	appName = wxEmptyString,
		const wxString &	vendorName = wxEmptyString,
		const wxString &	localFilename = wxEmptyString,
		const wxString &	globalFilename = wxEmptyString,
		long	style = wxCONFIG_USE_LOCAL_FILE | wxCONFIG_USE_GLOBAL_FILE,
		const wxMBConv &	conv = wxConvAuto()
	)

Definition at line 28 of file FileConfig.cpp.

:  wxConfigBase(appName, vendorName, localFilename, globalFilename, style),
   mAppName(appName),
   mVendorName(vendorName),
   mLocalFilename(localFilename),
   mGlobalFilename(globalFilename),
   mStyle(style),
   mConv(conv.Clone()),//pass to Init() instead?
   mDirty(false)
{
}

~FileConfig()

FileConfig::~FileConfig ( )

virtual

Definition at line 88 of file FileConfig.cpp.

{
   wxASSERT(mDirty == false);
}

References mDirty.

Member Function Documentation

DeleteAll()

bool FileConfig::DeleteAll ( )

virtual

Definition at line 229 of file FileConfig.cpp.

{
   auto res = mConfig->DeleteAll();
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References mConfig, and mDirty.

Referenced by ResetPreferences().

Here is the caller graph for this function:

DeleteEntry()

bool FileConfig::DeleteEntry ( const wxString &  key, bool  bDeleteGroupIfEmpty = true  )

virtual

Definition at line 209 of file FileConfig.cpp.

{
   auto res = mConfig->DeleteEntry(key, bDeleteGroupIfEmpty);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References key, mConfig, and mDirty.

Referenced by KeyConfigPrefs::Commit(), ModuleSettings::GetModuleStatus(), AudacityApp::OnExit(), KeyConfigPrefs::OnImportDefaults(), anonymous_namespace{AudacityApp.cpp}::PopulatePreferences(), PluginManager::RemoveConfig(), ToolBarConfiguration::Write(), and Importer::WriteImportItems().

Here is the caller graph for this function:

DeleteGroup()

bool FileConfig::DeleteGroup ( const wxString &  key )

virtual

Definition at line 219 of file FileConfig.cpp.

{
   auto res = mConfig->DeleteGroup(key);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References key, mConfig, and mDirty.

Referenced by TagsEditorDialog::OnSaveDefaults(), anonymous_namespace{AudacityApp.cpp}::PopulatePreferences(), and PluginManager::RemoveConfigSubgroup().

Here is the caller graph for this function:

DoReadLong()

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

protectedvirtual

Definition at line 244 of file FileConfig.cpp.

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

References key, and mConfig.

DoReadString()

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

protectedvirtual

Definition at line 239 of file FileConfig.cpp.

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

References key, and mConfig.

DoWriteLong()

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

protectedvirtual

Definition at line 266 of file FileConfig.cpp.

{
   bool res = mConfig->Write(key, lValue);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References key, mConfig, and mDirty.

DoWriteString()

bool FileConfig::DoWriteString ( const wxString &  key, const wxString &  szValue  )

protectedvirtual

Definition at line 256 of file FileConfig.cpp.

{
   bool res = mConfig->Write(key, szValue);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References key, mConfig, and mDirty.

Flush()

bool FileConfig::Flush ( bool  bCurrentOnly = false )

virtual

Definition at line 143 of file FileConfig.cpp.

{
   if (!mDirty)
   {
      return true;
   }
 
   while (true)
   {
      FilePath backup = mLocalFilename + ".bkp";
 
      if (!wxFileExists(backup) || (wxRemove(backup) == 0))
      {
         if (!wxFileExists(mLocalFilename) || (wxRename(mLocalFilename, backup) == 0))
         {
            wxFileOutputStream stream(mLocalFilename);
            if (stream.IsOk())
            {
               if (mConfig->Save(stream))
               {
                  stream.Sync();
                  if (stream.IsOk() && stream.Close())
                  {
                     if (!wxFileExists(backup) || (wxRemove(backup) == 0))
                     {
                        mDirty = false;
                        return true;
                     }
                  }
               }
            }
 
            if (wxFileExists(backup))
            {
               wxRemove(mLocalFilename);
               wxRename(backup, mLocalFilename);
            }
         }
      }
 
      Warn();
   }
 
   return false;
}

References mConfig, mDirty, mLocalFilename, and Warn().

Referenced by SetPreferenceCommand::Apply(), ApplyMacroDialog::ApplyMacroToProject(), ProjectSelectionManager::AS_SetSelectionFormat(), ProjectSelectionManager::AS_SetSnapTo(), AudacityApp::AssociateFileTypes(), ScreenshotCommand::CapturePreferences(), DeviceToolBar::ChangeHost(), AudioSetupToolBar::ChangeHost(), ExportMP3::CheckFileName(), cloud::audiocom::UserService::ClearUserData(), SettingTransaction::Commit(), GUIPrefs::Commit(), KeyConfigPrefs::Commit(), QualityPrefs::Commit(), TracksPrefs::Commit(), cloud::audiocom::OAuthService::DoAuthorise(), ToolsToolBar::DoToolChanged(), cloud::audiocom::UserService::DownloadAvatar(), ExportMP3::Export(), AudioSetupToolBar::FillHostDevices(), DeviceToolBar::FillHostDevices(), MP3Exporter::FindLibrary(), AudioIO::Init(), EffectNoiseRemoval::Init(), UpdateManager::IsTimeForUpdatesChecking(), LoadFFmpeg(), EnumSettingBase::Migrate(), SpectrogramSettings::ColorSchemeEnumSetting::Migrate(), TracksViewModeEnumSetting::Migrate(), ViewActions::Handler::OnAdvancedVZoom(), ApplyMacroDialog::OnApplyToFiles(), AdornedRulerPanel::OnAutoScroll(), PrefsDialog::OnCancel(), BrowserDialog::OnClose(), ScreenshotBigDialog::OnClose(), FrequencyPlotDialog::OnCloseButton(), ScreenshotBigDialog::OnCloseWindow(), AudioPasteDialog::OnContinue(), ScreenshotBigDialog::OnDirChoose(), SplashDialog::OnDontShow(), TagsEditorDialog::OnDontShow(), AudacityApp::OnExit(), ExportMultipleDialog::OnExport(), KeyConfigPrefs::OnImportDefaults(), ExportMP3Options::OnMono(), anonymous_namespace{TrackMenus.cpp}::OnMoveSelectionWithTracks(), PrefsDialog::OnOK(), ExportFFmpegOptions::OnOK(), SoundActivatedRecordDialog::OnOK(), TagsEditorDialog::OnOk(), TimerRecordDialog::OnOK(), FFmpegNotFoundDialog::OnOk(), MeterPanel::OnPreferences(), anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), TagsEditorDialog::OnSaveDefaults(), LabelTrackMenuTable::OnSetFont(), ViewActions::Handler::OnShowClipping(), ViewActions::Handler::OnShowExtraMenus(), ViewActions::Handler::OnShowNameOverlay(), anonymous_namespace{TrackMenus.cpp}::OnSyncLock(), AdornedRulerPanel::OnSyncSelToQuickPlay(), anonymous_namespace{TransportMenus.cpp}::OnTogglePlayRecording(), anonymous_namespace{TransportMenus.cpp}::OnToggleSoundActivated(), anonymous_namespace{TransportMenus.cpp}::OnToggleSWPlaythrough(), anonymous_namespace{LabelMenus.cpp}::OnToggleTypeToCreateLabel(), FFmpegImportPlugin::Open(), Registry::OrderingPreferenceInitializer::operator()(), cloud::audiocom::ShareAudioDialog::InitialStatePanel::PopulateFirstTimeNotice(), anonymous_namespace{HelpMenus.cpp}::QuickFixDialog::PopulateOrExchange(), anonymous_namespace{AudacityApp.cpp}::PopulatePreferences(), EffectNoiseReduction::Settings::PrefsIO(), ProjectRate::ProjectRate(), PluginManager::RemoveConfig(), PluginManager::RemoveConfigSubgroup(), CommandManager::RemoveDuplicateShortcuts(), MacrosWindow::SaveChanges(), SaveEncoding(), DependencyDialog::SaveFutureActionChoice(), SaveOtherFormat(), GlobalPrefsDialog::SavePreferredPage(), SelectionBar::SelectionModeUpdated(), PluginManager::SetConfigValue(), Importer::SetDefaultOpenType(), AudioSetupToolBar::SetDevices(), DeviceToolBar::SetDevices(), Importer::SetLastOpenType(), ModuleSettings::SetModuleStatus(), TracksPrefs::SetPinnedHeadPositionPreference(), TracksPrefs::SetPinnedHeadPreference(), Journal::SetRecordEnabled(), HelpSystem::ShowHelp(), EffectNoiseRemoval::ShowHostInterface(), ShowWarningDialog(), ProjectSelectionManager::SSBL_SetBandwidthSelectionFormatName(), ProjectSelectionManager::SSBL_SetFrequencySelectionFormatName(), UpdateManager::Start(), ExportCLOptions::TransferDataFromWindow(), ExportFFmpegAC3Options::TransferDataFromWindow(), ExportFFmpegAACOptions::TransferDataFromWindow(), ExportFFmpegAMRNBOptions::TransferDataFromWindow(), ExportFFmpegOPUSOptions::TransferDataFromWindow(), ExportFFmpegWMAOptions::TransferDataFromWindow(), ExportFLACOptions::TransferDataFromWindow(), ExportMP3Options::TransferDataFromWindow(), ExportOGGOptions::TransferDataFromWindow(), ExportWavPackOptions::TransferDataFromWindow(), ProjectSelectionManager::TT_SetAudioTimeFormat(), cloud::audiocom::OAuthService::UnlinkAccount(), EQCurveReader::UpdateDefaultCurves(), cloud::audiocom::anonymous_namespace{ShareAudioDialog.cpp}::UpdatePublicity(), cloud::audiocom::UserService::UpdateUserData(), Registry::Visit(), ToolManager::WriteConfig(), Importer::WriteImportItems(), and LabelDialog::WriteSize().

Here is the call graph for this function:

GetFilePath()

const FilePath & FileConfig::GetFilePath ( ) const

inlineprotected

Definition at line 81 of file FileConfig.h.

{ return mLocalFilename; }

Referenced by AudacityFileConfig::Warn().

Here is the caller graph for this function:

GetFirstEntry()

bool FileConfig::GetFirstEntry ( wxString &  str, long &  lIndex  ) const

virtual

Definition at line 113 of file FileConfig.cpp.

{
   return mConfig->GetFirstEntry(str, lIndex);
}

References mConfig, and str.

Referenced by ModulePrefs::GetAllModuleStatuses(), and Tags::LoadDefaults().

Here is the caller graph for this function:

GetFirstGroup()

bool FileConfig::GetFirstGroup ( wxString &  str, long &  lIndex  ) const

virtual

Definition at line 103 of file FileConfig.cpp.

{
   return mConfig->GetFirstGroup(str, lIndex);
}

References mConfig, and str.

Referenced by PluginManager::LoadGroup(), and anonymous_namespace{AudacityApp.cpp}::PopulatePreferences().

Here is the caller graph for this function:

GetNextEntry()

bool FileConfig::GetNextEntry ( wxString &  str, long &  lIndex  ) const

virtual

Definition at line 118 of file FileConfig.cpp.

{
   return mConfig->GetNextEntry(str, lIndex);
}

References mConfig, and str.

Referenced by ModulePrefs::GetAllModuleStatuses(), and Tags::LoadDefaults().

Here is the caller graph for this function:

GetNextGroup()

bool FileConfig::GetNextGroup ( wxString &  str, long &  lIndex  ) const

virtual

Definition at line 108 of file FileConfig.cpp.

{
   return mConfig->GetNextGroup(str, lIndex);
}

References mConfig, and str.

Referenced by PluginManager::LoadGroup(), and anonymous_namespace{AudacityApp.cpp}::PopulatePreferences().

Here is the caller graph for this function:

GetNumberOfEntries()

size_t FileConfig::GetNumberOfEntries ( bool  bRecursive = false ) const

virtual

Definition at line 123 of file FileConfig.cpp.

{
   return mConfig->GetNumberOfEntries(bRecursive);
}

References mConfig.

GetNumberOfGroups()

size_t FileConfig::GetNumberOfGroups ( bool  bRecursive = false ) const

virtual

Definition at line 128 of file FileConfig.cpp.

{
   return mConfig->GetNumberOfGroups(bRecursive);
}

References mConfig.

GetPath()

const wxString & FileConfig::GetPath ( ) const

virtual

Definition at line 98 of file FileConfig.cpp.

{
   return mConfig->GetPath();
}

References mConfig.

Referenced by PluginManager::GetSubgroups(), Tags::LoadDefaults(), anonymous_namespace{AudacityApp.cpp}::PopulatePreferences(), ToolManager::ReadConfig(), and ToolManager::WriteConfig().

Here is the caller graph for this function:

GetVersionKeysInit()

void FileConfig::GetVersionKeysInit ( int &  major, int &  minor, int &  micro  ) const

inline

Definition at line 56 of file FileConfig.h.

   {
      major = mVersionMajorKeyInit;
      minor = mVersionMinorKeyInit;
      micro = mVersionMicroKeyInit;
   }

Referenced by AudacityApp::InitPart2(), and ToolManager::ReadConfig().

Here is the caller graph for this function:

HasEntry()

bool FileConfig::HasEntry ( const wxString &  strName ) const

virtual

Definition at line 138 of file FileConfig.cpp.

{
   return mConfig->HasEntry(strName);
}

References mConfig.

Referenced by KeyConfigPrefs::Commit(), and CommandManager::NewIdentifier().

Here is the caller graph for this function:

HasGroup()

bool FileConfig::HasGroup ( const wxString &  strName ) const

virtual

Definition at line 133 of file FileConfig.cpp.

{
   return mConfig->HasGroup(strName);
}

References mConfig.

Init()

void FileConfig::Init

(

)

Definition at line 45 of file FileConfig.cpp.

{
   while (true)
   {
      mConfig = std::make_unique<wxFileConfig>
         (mAppName, mVendorName, mLocalFilename, mGlobalFilename, mStyle, *mConv);
 
      // Prevent wxFileConfig from attempting a Flush() during object deletion. This happens
      // because we don't use the wxFileConfig::Flush() method and so the wxFileConfig dirty
      // flag never gets reset. During deletion, the dirty flag is checked and a Flush()
      // performed. This can (and probably will) create bogus temporary files.
      mConfig->DisableAutoSave();
 
      bool canRead = false;
      bool canWrite = false;
      int fd;
 
      fd = wxOpen(mLocalFilename, O_RDONLY, S_IREAD);
      if (fd != -1 || errno == ENOENT)
      {
         canRead = true;
         if (fd != -1)
         {
            wxClose(fd);
         }
      }
 
      fd = wxOpen(mLocalFilename, O_WRONLY | O_CREAT, S_IWRITE);
      if (fd != -1)
      {
         canWrite = true;
         wxClose(fd);
      }
 
      if (canRead && canWrite)
      {
         break;
      }
 
      Warn();
   }
}

References mAppName, mConfig, mConv, mGlobalFilename, mLocalFilename, mStyle, mVendorName, and Warn().

Referenced by AudacityFileConfig::Create().

Here is the call graph for this function:

Here is the caller graph for this function:

RenameEntry()

bool FileConfig::RenameEntry ( const wxString &  oldName, const wxString &  newName  )

virtual

Definition at line 189 of file FileConfig.cpp.

{
   auto res = mConfig->RenameEntry(oldName, newName);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References mConfig, and mDirty.

RenameGroup()

bool FileConfig::RenameGroup ( const wxString &  oldName, const wxString &  newName  )

virtual

Definition at line 199 of file FileConfig.cpp.

{
   auto res = mConfig->RenameGroup(oldName, newName);
   if (res)
   {
      mDirty = true;
   }
   return res;
}

References mConfig, and mDirty.

SetPath()

void FileConfig::SetPath ( const wxString &  strPath )

virtual

Definition at line 93 of file FileConfig.cpp.

{
   mConfig->SetPath(strPath);
}

References mConfig.

Referenced by ModulePrefs::GetAllModuleStatuses(), PluginManager::GetSubgroups(), Tags::LoadDefaults(), PluginManager::LoadGroup(), CommandManager::NewIdentifier(), anonymous_namespace{AudacityApp.cpp}::PopulatePreferences(), ToolManager::ReadConfig(), PluginManager::SaveGroup(), and ToolManager::WriteConfig().

Here is the caller graph for this function:

SetVersionKeysInit()

void FileConfig::SetVersionKeysInit ( int  major, int  minor, int  micro  )

inline

Definition at line 50 of file FileConfig.h.

   {
      mVersionMajorKeyInit = major;
      mVersionMinorKeyInit = minor;
      mVersionMicroKeyInit = micro;
   }

Referenced by anonymous_namespace{AudacityApp.cpp}::PopulatePreferences().

Here is the caller graph for this function:

Warn()

void FileConfig::Warn ( )

protectedvirtual

Override to notify the user of error conditions involving writability of config files. Default implementation does nothing

Reimplemented in AudacityFileConfig.

Definition at line 288 of file FileConfig.cpp.

{
}

Referenced by Flush(), and Init().

Here is the caller graph for this function:

Member Data Documentation

mAppName

const wxString FileConfig::mAppName

private

Definition at line 84 of file FileConfig.h.

Referenced by Init().

mConfig

std::unique_ptr<wxFileConfig> FileConfig::mConfig

private

Definition at line 91 of file FileConfig.h.

Referenced by DeleteAll(), DeleteEntry(), DeleteGroup(), DoReadLong(), DoReadString(), DoWriteLong(), DoWriteString(), Flush(), GetFirstEntry(), GetFirstGroup(), GetNextEntry(), GetNextGroup(), GetNumberOfEntries(), GetNumberOfGroups(), GetPath(), HasEntry(), HasGroup(), Init(), RenameEntry(), RenameGroup(), and SetPath().

mConv

std::unique_ptr<wxMBConv> FileConfig::mConv

private

Definition at line 89 of file FileConfig.h.

Referenced by Init().

mDirty

bool FileConfig::mDirty

private

Definition at line 99 of file FileConfig.h.

Referenced by DeleteAll(), DeleteEntry(), DeleteGroup(), DoWriteLong(), DoWriteString(), Flush(), RenameEntry(), RenameGroup(), and ~FileConfig().

mGlobalFilename

const wxString FileConfig::mGlobalFilename

private

Definition at line 87 of file FileConfig.h.

Referenced by Init().

mLocalFilename

const wxString FileConfig::mLocalFilename

private

Definition at line 86 of file FileConfig.h.

Referenced by Flush(), and Init().

mStyle

const long FileConfig::mStyle

private

Definition at line 88 of file FileConfig.h.

Referenced by Init().

mVendorName

const wxString FileConfig::mVendorName

private

Definition at line 85 of file FileConfig.h.

Referenced by Init().

mVersionMajorKeyInit

int FileConfig::mVersionMajorKeyInit {}

private

Definition at line 95 of file FileConfig.h.

mVersionMicroKeyInit

int FileConfig::mVersionMicroKeyInit {}

private

Definition at line 97 of file FileConfig.h.

mVersionMinorKeyInit

int FileConfig::mVersionMinorKeyInit {}

private

Definition at line 96 of file FileConfig.h.

---

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

• FileConfig.h
• FileConfig.cpp