FileException.h

Go to the documentation of this file.

 
#ifndef __AUDACITY_FILE_EXCEPTION__
#define __AUDACITY_FILE_EXCEPTION__
 
#include "AudacityException.h" // to inherit
#include <wx/filename.h> // wxFileName member variable
 
class FILES_API FileException /* not final */
   : public MessageBoxException
{
public:
   enum class Cause {
      Open,
      Read,
      Write, 
      Rename 
   };
 
   explicit FileException(
      Cause cause_, 
      const wxFileName &fileName_, 
      const TranslatableString &caption = XO("File Error"), 
      const wxFileName &renameTarget_ = {} 
   )
   // DV: We consider a FileException to be internal for now.
   // We used to have some odd cases related to the read-only folder in 3.0.0,
   // so it is good to have a full picture here.
   // In case we see too many - we will tweak this behavior in the next release.
   : MessageBoxException{ ExceptionType::Internal, caption }
   , cause{ cause_ }, fileName{ fileName_ }, renameTarget{ renameTarget_ }
   {}
 
   FileException( const FileException &that )
      : MessageBoxException( that )
      , cause{ that.cause }
      , fileName{ that.fileName }
      , renameTarget{ that.renameTarget }
   {}
 
   FileException& operator= (FileException&&) = delete;
 
   ~FileException() override;
 
   static TranslatableString WriteFailureMessage(const wxFileName &fileName);
 
protected:
   TranslatableString ErrorMessage() const override;
   wxString ErrorHelpUrl() const override;
 
public:
   Cause cause;
   wxFileName fileName;
   wxFileName renameTarget;
};
 
#endif