Abstract AudacityException subclass displays a message, specified by further subclass. More...

#include <AudacityException.h>

Inheritance diagram for MessageBoxException:

Collaboration diagram for MessageBoxException:

Protected Member Functions
	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...

Protected Attributes
wxString	helpUrl { "" }

Private Member Functions
void	DelayedHandlerAction () final
	Do not allow subclasses to change behavior, except by overriding ErrorMessage(). More...

virtual void	DelayedHandlerAction ()=0
	Privatize the inherited function. More...

Private Attributes
TranslatableString	caption
	Stored caption. More...

ExceptionType	exceptionType
	Exception type. More...

bool	moved { false }
	Whether `*this` has been the source of a copy. More...

Additional Inherited Members
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 inherited from AudacityException
static void	EnqueueAction (std::exception_ptr pException, std::function< void(AudacityException *)> delayedHandler)

Detailed Description

Abstract AudacityException subclass displays a message, specified by further subclass.

At most one message will be displayed for each pass through the main event idle loop, no matter how many exceptions were caught.

Definition at line 60 of file AudacityException.h.

Constructor & Destructor Documentation

◆ MessageBoxException() [1/2]

MessageBoxException::MessageBoxException	(	ExceptionType	exceptionType,
		const TranslatableString &	caption
	)

explicitprotected

If default-constructed with empty caption, it makes no message box.

Parameters

exceptionType	Exception type
caption	Shown in message box's frame; not the actual message

Definition at line 39 of file AudacityException.cpp.

    : caption { caption_ }
    , exceptionType { exceptionType_ }
{
   if (!caption.empty())
      wxAtomicInc( sOutstandingMessages );
   else
      // invalidate me
      moved = true;
}

References caption, TranslatableString::empty(), moved, and sOutstandingMessages.

Here is the call graph for this function:

◆ ~MessageBoxException()

MessageBoxException::~MessageBoxException ( )

overrideprotected

Definition at line 64 of file AudacityException.cpp.

{
   if (!moved)
      // If exceptions are used properly, you should never reach this,
      // because moved should become true earlier in the object's lifetime.
      wxAtomicDec( sOutstandingMessages );
}

References moved, and sOutstandingMessages.

◆ MessageBoxException() [2/2]

MessageBoxException::MessageBoxException ( const MessageBoxException & that )

protected

Definition at line 55 of file AudacityException.cpp.

{
   caption = that.caption;
   moved = that.moved;
   helpUrl = that.helpUrl;
   exceptionType = that.exceptionType;
   that.moved = true;
}

References caption, exceptionType, helpUrl, and moved.

Member Function Documentation

◆ DelayedHandlerAction() [1/2]

void MessageBoxException::DelayedHandlerAction ( )

finalprivatevirtual

Do not allow subclasses to change behavior, except by overriding ErrorMessage().

Implements AudacityException.

Definition at line 82 of file AudacityException.cpp.

{
   if (!moved) {
      // This test prevents accumulation of multiple messages between idle
      // times of the main even loop.  Only the last queued exception
      // displays its message.  We assume that multiple messages have a
      // common cause such as exhaustion of disk space so that the others
      // give the user no useful added information.
 
      using namespace BasicUI;
      if ( wxAtomicDec( sOutstandingMessages ) == 0 ) {
         if (exceptionType != ExceptionType::Internal
             && ErrorHelpUrl().IsEmpty()) {
            // We show BadEnvironment and BadUserAction in a similar way
            ShowMessageBox(
               ErrorMessage(),
               MessageBoxOptions{}
                  .Caption(caption.empty() ? DefaultCaption() : caption)
                  .IconStyle(Icon::Error) );
         }
         else {
            using namespace BasicUI;
            auto type = exceptionType == ExceptionType::Internal
               ? ErrorDialogType::ModalErrorReport : ErrorDialogType::ModalError;
            ShowErrorDialog( {},
               (caption.empty() ? DefaultCaption() : caption),
               ErrorMessage(),
               ErrorHelpUrl(),
               ErrorDialogOptions{ type } );
         }
      }
 
      moved = true;
   }
}

References BasicUI::MessageBoxOptions::Caption(), caption, BasicUI::DefaultCaption(), TranslatableString::empty(), ErrorHelpUrl(), ErrorMessage(), exceptionType, Internal, moved, BasicUI::ShowErrorDialog(), BasicUI::ShowMessageBox(), and sOutstandingMessages.

Here is the call graph for this function:

◆ DelayedHandlerAction() [2/2]

virtual void AudacityException::DelayedHandlerAction ( )

privatevirtual

Privatize the inherited function.

Implements AudacityException.

◆ ErrorHelpUrl()

virtual wxString MessageBoxException::ErrorHelpUrl ( ) const

inlineprotectedvirtual

Reimplemented in FileException.

Definition at line 81 of file AudacityException.h.

81{ return helpUrl; };

Referenced by DelayedHandlerAction().

Here is the caller graph for this function:

◆ ErrorMessage()

virtual TranslatableString MessageBoxException::ErrorMessage ( ) const

protectedpure virtual

Format the error message for this exception.

Implemented in SimpleMessageBoxException, InconsistencyException, and FileException.

Referenced by DelayedHandlerAction().

Here is the caller graph for this function:

Member Data Documentation

◆ caption

TranslatableString MessageBoxException::caption

private

Stored caption.

Definition at line 84 of file AudacityException.h.

Referenced by DelayedHandlerAction(), and MessageBoxException().

◆ exceptionType

ExceptionType MessageBoxException::exceptionType

private

Exception type.

Definition at line 85 of file AudacityException.h.

Referenced by DelayedHandlerAction(), and MessageBoxException().

◆ helpUrl

wxString MessageBoxException::helpUrl { "" }

mutableprotected

Definition at line 89 of file AudacityException.h.

Referenced by MessageBoxException().

◆ moved

bool MessageBoxException::moved { false }

mutableprivate

Whether *this has been the source of a copy.

Definition at line 87 of file AudacityException.h.

Referenced by DelayedHandlerAction(), MessageBoxException(), and ~MessageBoxException().

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

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members