ProjectManager.h

Go to the documentation of this file.

/**********************************************************************
 
Audacity: A Digital Audio Editor
 
ProjectManager.h
 
Paul Licameli split from AudacityProject.h
 
**********************************************************************/
 
#ifndef __AUDACITY_PROJECT_MANAGER__
#define __AUDACITY_PROJECT_MANAGER__
 
#include <memory>
 
#include <wx/event.h> // to inherit
#include "ClientData.h" // to inherit
#include "Identifier.h"
#include "Observer.h"
 
class wxTimer;
class wxTimerEvent;
 
class AudacityProject;
struct AudioIOStartStreamOptions;
 
using StatusBarField = Identifier;
enum class ProjectFileIOMessage : int;
 
class AUDACITY_DLL_API ProjectManager final
   : public wxEvtHandler
   , public ClientData::Base
{
public:
   static ProjectManager &Get( AudacityProject &project );
   static const ProjectManager &Get( const AudacityProject &project );
 
   explicit ProjectManager( AudacityProject &project );
   ProjectManager( const ProjectManager & ) = delete;
   ProjectManager &operator=( const ProjectManager & ) = delete;
   ~ProjectManager() override;
 
   // This is the factory for projects:
   static AudacityProject *New();
 
   // The function that imports files can act as a factory too, and for that
   // reason remains in this class, not in ProjectFileManager
   static void OpenFiles(AudacityProject *proj);
 
   static bool SafeToOpenProjectInto(AudacityProject &proj);
 
 
   class ProjectChooser {
   public:
      ProjectChooser( AudacityProject *pProject, bool reuseNonemptyProject )
         : mpGivenProject{ pProject }
         , mReuseNonemptyProject{ reuseNonemptyProject }
      {}
      ProjectChooser( const ProjectChooser& ) = delete;
      ~ProjectChooser();
      AudacityProject &operator() ( bool openingProjectFile );
      void Commit();
 
   private:
      AudacityProject *mpGivenProject;
      AudacityProject *mpUsedProject = nullptr;
      bool mReuseNonemptyProject;
   };
 
 
   static AudacityProject *OpenProject(
      AudacityProject *pGivenProject,
      const FilePath &fileNameArg, bool addtohistory, bool reuseNonemptyProject);
 
   void ResetProjectToEmpty();
 
   static void SaveWindowSize();
 
   // Routine to estimate how many minutes of recording time are left on disk
   int GetEstimatedRecordingMinsLeftOnDisk(long lCaptureChannels = 0);
   // Converts number of minutes to human readable format
   TranslatableString GetHoursMinsString(int iMinutes);
 
   void SetStatusText(const TranslatableString& text, const StatusBarField& field);
   void SetStatusText(const TranslatableString& text, int number);
   void SetSkipSavePrompt(bool bSkip) { sbSkipPromptingForSave = bSkip; };
 
   static void SetClosingAll(bool closing);
 
private:
   void OnReconnectionFailure(ProjectFileIOMessage);
   void OnCloseWindow(wxCloseEvent & event);
   void OnTimer(wxTimerEvent & event);
   void OnStatusChange(StatusBarField field);
 
   void RestartTimer();
 
   // non-static data members
   AudacityProject &mProject;
 
   std::unique_ptr<wxTimer> mTimer;
 
   Observer::Subscription mProjectStatusSubscription,
      mProjectFileIOSubscription;
 
   DECLARE_EVENT_TABLE()
 
   static bool sbWindowRectAlreadySaved;
   static bool sbSkipPromptingForSave;
};
 
#endif