FileHistory Class Reference

Similar to wxFileHistory, but customized to our needs. More...

#include <FileHistory.h>

Collaboration diagram for FileHistory:

Public Types
enum	{ ID_RECENT_CLEAR = 6100 , ID_RECENT_FIRST = 6101 , ID_RECENT_LAST = 6112 }
using	const_iterator = FilePaths::const_iterator

Public Member Functions
	FileHistory (size_t maxfiles=12, wxWindowID idbase=wxID_FILE)
virtual	~FileHistory ()
	FileHistory (const FileHistory &)=delete
FileHistory &	operator= (const FileHistory &)=delete
void	Append (const FilePath &file)
void	Remove (size_t i)
void	Clear ()
void	UseMenu (wxMenu *menu)
void	Load (audacity::BasicSettings &config, const wxString &group=wxEmptyString)
void	Save (audacity::BasicSettings &config)
const_iterator	begin () const
const_iterator	end () const
const FilePath &	operator[] (size_t ii) const
bool	empty () const

Static Public Member Functions
static FileHistory &	Global ()

Private Member Functions
void	AddFileToHistory (const FilePath &file, bool update)
void	NotifyMenus ()
void	NotifyMenu (wxMenu *menu)
void	Compress ()

Private Attributes
size_t	mMaxFiles
wxWindowID	mIDBase
std::vector< wxWeakRef< wxMenu > >	mMenus
FilePaths	mHistory
wxString	mGroup

Detailed Description

Similar to wxFileHistory, but customized to our needs.

Definition at line 29 of file FileHistory.h.

Member Typedef Documentation

const_iterator

using FileHistory::const_iterator = FilePaths::const_iterator

Definition at line 59 of file FileHistory.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
ID_RECENT_CLEAR
ID_RECENT_FIRST
ID_RECENT_LAST

Definition at line 38 of file FileHistory.h.

        {
      ID_RECENT_CLEAR = 6100,
      ID_RECENT_FIRST = 6101,
      ID_RECENT_LAST  = 6112
   };

Constructor & Destructor Documentation

FileHistory() [1/2]

FileHistory::FileHistory	(	size_t	maxfiles = 12,
		wxWindowID	idbase = wxID_FILE
	)

Definition at line 29 of file FileHistory.cpp.

{
   mMaxFiles = maxfiles;
   mIDBase = base;
}

References mIDBase, and mMaxFiles.

~FileHistory()

FileHistory::~FileHistory ( )

virtual

Definition at line 35 of file FileHistory.cpp.

{
}

FileHistory() [2/2]

FileHistory::FileHistory ( const FileHistory &  )

delete

Member Function Documentation

AddFileToHistory()

void FileHistory::AddFileToHistory ( const FilePath &  file, bool  update  )

private

Definition at line 53 of file FileHistory.cpp.

{
   // Needed to transition from wxFileHistory to FileHistory since there
   // can be empty history "slots".
   if (file.empty()) {
      return;
   }
 
#if defined(__WXMSW__)
   int i = mHistory.Index(file, false);
#else
   int i = mHistory.Index(file, true);
#endif
 
   if (i != wxNOT_FOUND) {
      mHistory.erase( mHistory.begin() + i );
   }
 
   if (mMaxFiles > 0 && mMaxFiles == mHistory.size()) {
      mHistory.erase( mHistory.end() - 1 );
   }
 
   mHistory.insert(mHistory.begin(), file);
 
   if (update)
      NotifyMenus();
}

References wxArrayStringEx::insert(), mHistory, mMaxFiles, and NotifyMenus().

Referenced by Load().

Here is the call graph for this function:

Here is the caller graph for this function:

Append()

void FileHistory::Append ( const FilePath &  file )

inline

Definition at line 46 of file FileHistory.h.

   { AddFileToHistory( file, true ); }

Referenced by anonymous_namespace{FileMenus.cpp}::DoExport(), ProjectFileManager::DoImport(), anonymous_namespace{ImportMIDI.cpp}::DoImportMIDI(), ProjectFileManager::OpenProjectFile(), ExportOptionsCLEditor::PopulateUI(), ProjectFileManager::SaveAs(), ProjectFileManager::SaveFromTimerRecording(), and ExportOptionsCLEditor::TransferDataFromWindow().

Here is the caller graph for this function:

begin()

const_iterator FileHistory::begin ( ) const

inline

Definition at line 60 of file FileHistory.h.

{ return mHistory.begin(); }

Referenced by ExportOptionsCLEditor::PopulateUI().

Here is the caller graph for this function:

Clear()

void FileHistory::Clear

(

)

Definition at line 92 of file FileHistory.cpp.

{
   mHistory.clear();
 
   NotifyMenus();
}

References mHistory, and NotifyMenus().

Referenced by AudacityApp::OnMRUClear().

Here is the call graph for this function:

Here is the caller graph for this function:

Compress()

void FileHistory::Compress ( )

private

Definition at line 171 of file FileHistory.cpp.

{
   // Clear up expired weak pointers
   auto end = mMenus.end();
   mMenus.erase(
     std::remove_if( mMenus.begin(), end,
        [](wxWeakRef<wxMenu> &pMenu){ return !pMenu; } ),
     end
   );
}

References end(), and mMenus.

Referenced by NotifyMenus(), and UseMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

empty()

bool FileHistory::empty ( ) const

inline

Definition at line 63 of file FileHistory.h.

{ return mHistory.empty(); }

Referenced by ExportOptionsCLEditor::PopulateUI().

Here is the caller graph for this function:

end()

const_iterator FileHistory::end ( ) const

inline

Definition at line 61 of file FileHistory.h.

{ return mHistory.end(); }

Referenced by Compress(), NotifyMenu(), ExportOptionsCLEditor::PopulateUI(), and UseMenu().

Here is the caller graph for this function:

Global()

FileHistory & FileHistory::Global ( )

static

Definition at line 39 of file FileHistory.cpp.

{
   // TODO - read the number of files to store in history from preferences
   static FileHistory history{
      ID_RECENT_LAST - ID_RECENT_FIRST + 1, ID_RECENT_CLEAR };
   static std::once_flag flag;
   std::call_once( flag, [&]{
      history.Load(*gPrefs, wxT("RecentFiles"));
   });
 
   return history;
}

References flag, gPrefs, ID_RECENT_CLEAR, ID_RECENT_FIRST, ID_RECENT_LAST, and wxT().

Referenced by anonymous_namespace{FileMenus.cpp}::DoExport(), ProjectFileManager::DoImport(), anonymous_namespace{ImportMIDI.cpp}::DoImportMIDI(), anonymous_namespace{FileMenus.cpp}::FileMenu(), AudacityApp::InitPart2(), AudacityApp::OnExit(), AudacityApp::OnMRUClear(), AudacityApp::OnMRUFile(), ProjectFileManager::OpenProjectFile(), ProjectFileManager::SaveAs(), and ProjectFileManager::SaveFromTimerRecording().

Here is the call graph for this function:

Here is the caller graph for this function:

Load()

void FileHistory::Load	(	audacity::BasicSettings &	config,
		const wxString &	group = wxEmptyString
	)

Definition at line 116 of file FileHistory.cpp.

{
   mHistory.clear();
   mGroup = group.empty()
      ? wxString{ "RecentFiles" }
      : group;
 
   const auto localGroup = settings.BeginGroup(mGroup);
   for(const auto& key : settings.GetChildKeys())
      AddFileToHistory(settings.Read(key), false);
   
   NotifyMenus();
}

References AddFileToHistory(), key, mGroup, mHistory, NotifyMenus(), and settings().

Referenced by ExportOptionsCLEditor::PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

NotifyMenu()

void FileHistory::NotifyMenu ( wxMenu *  menu )

private

Definition at line 152 of file FileHistory.cpp.

{
   wxMenuItemList items = menu->GetMenuItems();
   for (auto end = items.end(), iter = items.begin(); iter != end;)
      menu->Destroy(*iter++);
 
   for (size_t i = 0; i < mHistory.size(); i++) {
      wxString item =  mHistory[i];
      item.Replace( "&", "&&" );
      menu->Append(mIDBase + 1 + i,item);
   }
 
   if (mHistory.size() > 0) {
      menu->AppendSeparator();
   }
   menu->Append(mIDBase, _("&Clear"));
   menu->Enable(mIDBase, mHistory.size() > 0);
}

References _, end(), mHistory, and mIDBase.

Referenced by NotifyMenus(), and UseMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

NotifyMenus()

void FileHistory::NotifyMenus ( )

private

Definition at line 143 of file FileHistory.cpp.

{
   Compress();
   for (auto pMenu : mMenus)
      if (pMenu)
         NotifyMenu(pMenu);
   Save(*gPrefs);
}

References Compress(), gPrefs, mMenus, NotifyMenu(), and Save().

Referenced by AddFileToHistory(), Clear(), Load(), and Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

FileHistory & FileHistory::operator= ( const FileHistory &  )

delete

operator[]()

const FilePath & FileHistory::operator[] ( size_t  ii ) const

inline

Definition at line 62 of file FileHistory.h.

{ return mHistory[ ii ]; }

Remove()

void FileHistory::Remove

(

size_t

i

)

Definition at line 81 of file FileHistory.cpp.

{
   wxASSERT(i < mHistory.size());
 
   if (i < mHistory.size()) {
      mHistory.erase( mHistory.begin() + i );
 
      NotifyMenus();
   }
}

References mHistory, and NotifyMenus().

Here is the call graph for this function:

Save()

void FileHistory::Save

(

audacity::BasicSettings &

config

)

Definition at line 130 of file FileHistory.cpp.

{
   auto group = settings.BeginGroup(mGroup);
   settings.Remove({});
   
   // Stored in reverse order
   int n = mHistory.size() - 1;
   for (size_t i = 1; i <= mHistory.size(); i++) {
      settings.Write(wxString::Format(wxT("file%02d"), (int)i), mHistory[n--]);
   }
   settings.Flush();
}

References mGroup, mHistory, settings(), and wxT().

Referenced by NotifyMenus(), AudacityApp::OnExit(), and ExportOptionsCLEditor::TransferDataFromWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

UseMenu()

void FileHistory::UseMenu

(

wxMenu *

menu

)

Definition at line 99 of file FileHistory.cpp.

{
   Compress();
 
   auto end = mMenus.end();
   auto iter = std::find(mMenus.begin(), end, menu);
   auto found = (iter != end);
 
   if (!found)
      mMenus.push_back(menu);
   else {
      wxASSERT(false);
   }
 
   NotifyMenu( menu );
}

References Compress(), end(), mMenus, and NotifyMenu().

Here is the call graph for this function:

Member Data Documentation

mGroup

wxString FileHistory::mGroup

private

Definition at line 78 of file FileHistory.h.

Referenced by Load(), and Save().

mHistory

FilePaths FileHistory::mHistory

private

Definition at line 76 of file FileHistory.h.

Referenced by AddFileToHistory(), Clear(), Load(), NotifyMenu(), Remove(), and Save().

mIDBase

wxWindowID FileHistory::mIDBase

private

Definition at line 73 of file FileHistory.h.

Referenced by FileHistory(), and NotifyMenu().

mMaxFiles

size_t FileHistory::mMaxFiles

private

Definition at line 72 of file FileHistory.h.

Referenced by AddFileToHistory(), and FileHistory().

mMenus

std::vector< wxWeakRef< wxMenu > > FileHistory::mMenus

private

Definition at line 75 of file FileHistory.h.

Referenced by Compress(), NotifyMenus(), and UseMenu().

---

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

• FileHistory.h
• FileHistory.cpp