ProjectFileManager.h

Go to the documentation of this file.

/**********************************************************************
 
Audacity: A Digital Audio Editor
 
ProjectFileManager.h
 
Paul Licameli split from AudacityProject.h
 
**********************************************************************/
 
#ifndef __AUDACITY_PROJECT_FILE_MANAGER__
#define __AUDACITY_PROJECT_FILE_MANAGER__
 
#include <functional>
#include <memory>
#include <vector>
 
#include "ClientData.h" // to inherit
#include "FileNames.h" // for FileType
 
class wxString;
class wxFileName;
class AudacityProject;
class Track;
class TrackList;
class WaveTrack;
class XMLTagHandler;
class ClipMirAudioReader;
 
using TrackHolders = std::vector<std::shared_ptr<Track>>;
 
class AUDACITY_DLL_API ProjectFileManager final
   : public ClientData::Base
{
public:
   static ProjectFileManager &Get( AudacityProject &project );
   static const ProjectFileManager &Get( const AudacityProject &project );
 
   // Open and close a file, invisibly, removing its Autosave blob
   static void DiscardAutosave(const FilePath &filename);
 
   explicit ProjectFileManager( AudacityProject &project );
   ProjectFileManager( const ProjectFileManager & ) = delete;
   ProjectFileManager &operator=( const ProjectFileManager & ) = delete;
   ~ProjectFileManager();
 
   bool OpenProject();
   void CloseProject();
   bool OpenNewProject();
 
   void CompactProjectOnClose();
 
   bool Save();
   bool SaveAs(bool allowOverwrite = false);
   bool SaveAs(const FilePath &newFileName, bool addToHistory = true);
   // strProjectPathName is full path for aup except extension
   bool SaveFromTimerRecording( wxFileName fnFile );
   bool SaveCopy(const FilePath &fileName = wxT(""));
 
   static wxArrayString ShowOpenDialog(FileNames::Operation op,
      const FileNames::FileType &extraType = {});
 
   static bool IsAlreadyOpen(const FilePath &projPathName);
 
   using ProjectChooserFn = std::function<AudacityProject&(bool)>;
 
   static AudacityProject *OpenFile( const ProjectChooserFn &chooser,
      const FilePath &fileName, bool addtohistory = true);
 
   bool
   Import(const std::vector<FilePath>& fileNames, bool addToHistory = true);
   bool Import(const FilePath& fileName, bool addToHistory = true);
 
   void Compact();
 
   void AddImportedTracks(const FilePath &fileName,
                     TrackHolders &&newTracks);
 
   bool GetMenuClose() const { return mMenuClose; }
   void SetMenuClose(bool value) { mMenuClose = value; }
 
   static void FixTracks(TrackList& tracks,
                         const std::function<void(const TranslatableString&/*errorMessage*/)>& onError,
                         const std::function<void(const TranslatableString&/*unlinkReason*/)>& onUnlink);
 
private:
   bool Import(
      const FilePath& fileName, bool addToHistory,
      std::shared_ptr<ClipMirAudioReader>& resultingReader);
 
   AudacityProject *OpenProjectFile(
      const FilePath &fileName, bool addtohistory);
 
   struct ReadProjectResults
   {
      bool parseSuccess;
      bool trackError;
      const TranslatableString errorString;
      wxString helpUrl;
   };
   ReadProjectResults ReadProjectFile(
      const FilePath &fileName, bool discardAutosave = false );
 
   bool DoSave(const FilePath & fileName, bool fromSaveAs);
 
   AudacityProject &mProject;
 
   std::shared_ptr<TrackList> mLastSavedTracks;
 
   // Are we currently closing as the result of a menu command?
   bool mMenuClose{ false };
};
 
class wxTopLevelWindow;
 
class TitleRestorer{
public:
   TitleRestorer( wxTopLevelWindow &window, AudacityProject &project );
   ~TitleRestorer();
   wxString sProjNumber;
   wxString sProjName;
   size_t UnnamedCount;
};
 
#endif