Thrown for failure of file or database operations in deeply nested places. More...

#include <FileException.h>

Inheritance diagram for FileException:

Collaboration diagram for FileException:

Public Types
enum class	Cause { Open , Read , Write , Rename }
	Identifies file operation that failed. More...

Public Member Functions
	FileException (Cause cause_, const wxFileName &fileName_, const TranslatableString &caption=XO("File Error"), const wxFileName &renameTarget_={})

	FileException (const FileException &that)

FileException &	operator= (FileException &&)=delete

	~FileException () override

Public Member Functions inherited from AudacityException
	AudacityException ()

virtual	~AudacityException ()=0

virtual void	DelayedHandlerAction ()=0
	Action to do in the main thread at idle time of the event loop. More...

Static Public Member Functions
static TranslatableString	WriteFailureMessage (const wxFileName &fileName)

Static Public Member Functions inherited from AudacityException
static void	EnqueueAction (std::exception_ptr pException, std::function< void(AudacityException *)> delayedHandler)

Public Attributes
Cause	cause

wxFileName	fileName

wxFileName	renameTarget

Protected Member Functions
TranslatableString	ErrorMessage () const override
	Format an error message appropriate for the Cause. More...

wxString	ErrorHelpUrl () const override

Protected Member Functions inherited from MessageBoxException
	MessageBoxException (ExceptionType exceptionType, const TranslatableString &caption)
	If default-constructed with empty caption, it makes no message box. More...

	~MessageBoxException () override

	MessageBoxException (const MessageBoxException &)

virtual TranslatableString	ErrorMessage () const =0
	Format the error message for this exception. More...

virtual wxString	ErrorHelpUrl () const

Protected Member Functions inherited from AudacityException
	AudacityException (const AudacityException &)=default
	Make this protected to prevent slicing copies. More...

	AudacityException (AudacityException &&)=delete
	Don't allow moves of this class or subclasses. More...

AudacityException &	operator= (const AudacityException &)=delete
	Disallow assignment. More...

Additional Inherited Members
Protected Attributes inherited from MessageBoxException
wxString	helpUrl { "" }

Detailed Description

Thrown for failure of file or database operations in deeply nested places.

Definition at line 17 of file FileException.h.

Member Enumeration Documentation

◆ Cause

enum class FileException::Cause

strong

Identifies file operation that failed.

Enumerator
Open
Read
Write	most important to detect when storage space is exhausted
Rename	involves two filenames

Definition at line 22 of file FileException.h.

                    {
      Open,
      Read,
      Write, 
      Rename 
   };

Constructor & Destructor Documentation

◆ FileException() [1/2]

FileException::FileException	(	Cause	cause_,
		const wxFileName &	fileName_,
		const TranslatableString &	caption = `XO("File Error")`,
		const wxFileName &	renameTarget_ = `{}`
	)

inlineexplicit

Parameters

cause_	What kind of file operation failed
fileName_	Which file suffered a failure
caption	Shown in message box frame, not the main message
renameTarget_	A second file name, only for renaming failure

Definition at line 29 of file FileException.h.

                                        {} 
   )
   // 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() [2/2]

FileException::FileException ( const FileException & that )

inline

Definition at line 43 of file FileException.h.

      : MessageBoxException( that )
      , cause{ that.cause }
      , fileName{ that.fileName }
      , renameTarget{ that.renameTarget }
   {}

◆ ~FileException()

FileException::~FileException ( )

override

Definition at line 15 of file FileException.cpp.

16{

17}

Member Function Documentation

◆ ErrorHelpUrl()

wxString FileException::ErrorHelpUrl ( ) const

overrideprotectedvirtual

Reimplemented from MessageBoxException.

Definition at line 42 of file FileException.cpp.

{
   switch (cause) {
   case Cause::Open:
   case Cause::Read:
      return "Error:_Opening_or_reading_file";
      break;
   case Cause::Write:
   case Cause::Rename:
      return "Error:_Disk_full_or_not_writable";
   default:
      break;
   }
 
   return "";
}

References cause, Open, Read, Rename, and Write.

◆ ErrorMessage()

TranslatableString FileException::ErrorMessage ( ) const

overrideprotectedvirtual

Format an error message appropriate for the Cause.

Implements MessageBoxException.

Definition at line 19 of file FileException.cpp.

{
   TranslatableString format;
   switch (cause) {
      case Cause::Open:
         format = XO("Audacity failed to open a file in %s.");
         break;
      case Cause::Read:
         format = XO("Audacity failed to read from a file in %s.");
         break;
      case Cause::Write:
         return WriteFailureMessage(fileName);
      case Cause::Rename:
         format =
XO("Audacity successfully wrote a file in %s but failed to rename it as %s.");
      default:
         break;
   }
 
   return format.Format(
      FileNames::AbbreviatePath(fileName), renameTarget.GetFullName() );
}

References FileNames::AbbreviatePath(), cause, fileName, anonymous_namespace{ExportPCM.cpp}::format, Open, Read, Rename, renameTarget, Write, WriteFailureMessage(), and XO().

Here is the call graph for this function:

◆ operator=()

FileException & FileException::operator= ( FileException && )

delete

◆ WriteFailureMessage()

TranslatableString FileException::WriteFailureMessage ( const wxFileName & fileName )

static

Definition at line 60 of file FileException.cpp.

{
   return XO("Audacity failed to write to a file.\n"
     "Perhaps %s is not writable or the disk is full."
   ).Format(FileNames::AbbreviatePath(fileName));
}

References FileNames::AbbreviatePath(), fileName, and XO().

Referenced by ProjectFileManager::DoSave(), ErrorMessage(), ProjectFileManager::SaveCopy(), ProjectFileIO::SaveProject(), and ShowDiskFullExportErrorDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ cause

Cause FileException::cause

Definition at line 62 of file FileException.h.

Referenced by ErrorHelpUrl(), and ErrorMessage().

◆ fileName

wxFileName FileException::fileName

Definition at line 63 of file FileException.h.

Referenced by ErrorMessage(), and WriteFailureMessage().

◆ renameTarget

wxFileName FileException::renameTarget

Definition at line 64 of file FileException.h.

Referenced by ErrorMessage().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members