Refactor exceptions.

Author: Mysticial

SerialPrograms/CMakeLists.txt

@@ -310,17 +310,12 @@ file(GLOB MAIN_SOURCES
     Source/CommonFramework/ErrorReports/ProgramDumper.cpp
     Source/CommonFramework/ErrorReports/ProgramDumper.h
     Source/CommonFramework/ErrorReports/ProgramDumper_Windows.tpp
-    Source/CommonFramework/Exceptions/FatalProgramException.cpp
     Source/CommonFramework/Exceptions/FatalProgramException.h
-    Source/CommonFramework/Exceptions/OliveActionFailedException.cpp
-    Source/CommonFramework/Exceptions/OliveActionFailedException.h    
-    Source/CommonFramework/Exceptions/OperationFailedException.cpp
     Source/CommonFramework/Exceptions/OperationFailedException.h
     Source/CommonFramework/Exceptions/ProgramFinishedException.cpp
     Source/CommonFramework/Exceptions/ProgramFinishedException.h
     Source/CommonFramework/Exceptions/ScreenshotException.cpp
     Source/CommonFramework/Exceptions/ScreenshotException.h
-    Source/CommonFramework/Exceptions/UnexpectedBattleException.cpp
     Source/CommonFramework/Exceptions/UnexpectedBattleException.h
     Source/CommonFramework/GlobalServices.cpp
     Source/CommonFramework/GlobalServices.h
@@ -1508,6 +1503,7 @@ file(GLOB MAIN_SOURCES
     Source/PokemonSV/Programs/AutoStory/PokemonSV_MenuOption.h
     Source/PokemonSV/Programs/AutoStory/PokemonSV_MenuOptionDatabase.cpp
     Source/PokemonSV/Programs/AutoStory/PokemonSV_MenuOptionDatabase.h
+    Source/PokemonSV/Programs/AutoStory/PokemonSV_OliveActionFailedException.h
     Source/PokemonSV/Programs/Battles/PokemonSV_BasicCatcher.cpp
     Source/PokemonSV/Programs/Battles/PokemonSV_BasicCatcher.h
     Source/PokemonSV/Programs/Battles/PokemonSV_Battles.cpp

SerialPrograms/SerialPrograms.pro

@@ -179,12 +179,8 @@ SOURCES += \
     Source/CommonFramework/Environment/SystemSleep.cpp \
     Source/CommonFramework/ErrorReports/ErrorReports.cpp \
     Source/CommonFramework/ErrorReports/ProgramDumper.cpp \
-    Source/CommonFramework/Exceptions/FatalProgramException.cpp \
-    Source/CommonFramework/Exceptions/OliveActionFailedException.cpp \
-    Source/CommonFramework/Exceptions/OperationFailedException.cpp \
     Source/CommonFramework/Exceptions/ProgramFinishedException.cpp \
     Source/CommonFramework/Exceptions/ScreenshotException.cpp \
-    Source/CommonFramework/Exceptions/UnexpectedBattleException.cpp \
     Source/CommonFramework/GlobalServices.cpp \
     Source/CommonFramework/GlobalSettingsPanel.cpp \
     Source/CommonFramework/Globals.cpp \
@@ -730,7 +726,7 @@ SOURCES += \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_06.cpp \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_07.cpp \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_08.cpp \
-    Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_09.cpp \ 
+    Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_09.cpp \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_10.cpp \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_11.cpp \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_12.cpp \
@@ -1263,7 +1259,6 @@ HEADERS += \
     Source/CommonFramework/ErrorReports/ProgramDumper.h \
     Source/CommonFramework/ErrorReports/ProgramDumper_Windows.tpp \
     Source/CommonFramework/Exceptions/FatalProgramException.h \
-    Source/CommonFramework/Exceptions/OliveActionFailedException.h \
     Source/CommonFramework/Exceptions/OperationFailedException.h \
     Source/CommonFramework/Exceptions/ProgramFinishedException.h \
     Source/CommonFramework/Exceptions/ScreenshotException.h \
@@ -1471,7 +1466,6 @@ HEADERS += \
     Source/Kernels/BinaryMatrix/Kernels_SparseBinaryMatrixCore.h \
     Source/Kernels/BinaryMatrix/Kernels_SparseBinaryMatrixCore.tpp \
     Source/Kernels/ImageFilters/Kernels_ImageFilter_Basic.h \
-    Source/Kernels/ImageFilters/Kernels_ImageFilter_Green_Default.h \
     Source/Kernels/ImageScaleBrightness/Kernels_ImageScaleBrightness.h \
     Source/Kernels/ImageStats/Kernels_ImagePixelSumSqr.h \
     Source/Kernels/ImageStats/Kernels_ImagePixelSumSqrDev.h \
@@ -1807,7 +1801,7 @@ HEADERS += \
     Source/PokemonSV/Inference/PokemonSV_ClothingTopDetector.h \
     Source/PokemonSV/Inference/PokemonSV_ESPEmotionDetector.h \
     Source/PokemonSV/Inference/PokemonSV_MainMenuDetector.h \
-    Source/PokemonSV/Inference/PokemonSV_MenuOptionReader.h \    
+    Source/PokemonSV/Inference/PokemonSV_MenuOptionReader.h \
     Source/PokemonSV/Inference/PokemonSV_MoneyReader.h \
     Source/PokemonSV/Inference/PokemonSV_PokemonMovesReader.h \
     Source/PokemonSV/Inference/PokemonSV_PokePortalDetector.h \
@@ -1855,7 +1849,7 @@ HEADERS += \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_06.h \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_07.h \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_08.h \
-    Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_09.h \   
+    Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_09.h \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_10.h \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_11.h \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStory_Segment_12.h \
@@ -1875,6 +1869,7 @@ HEADERS += \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_AutoStoryTools.h \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_MenuOption.h \
     Source/PokemonSV/Programs/AutoStory/PokemonSV_MenuOptionDatabase.h \
+    Source/PokemonSV/Programs/AutoStory/PokemonSV_OliveActionFailedException.h \
     Source/PokemonSV/Programs/Battles/PokemonSV_BasicCatcher.h \
     Source/PokemonSV/Programs/Battles/PokemonSV_Battles.h \
     Source/PokemonSV/Programs/Battles/PokemonSV_SinglesBattler.h \

SerialPrograms/Source/CommonFramework/Exceptions/FatalProgramException.cpp

@@ -16,7 +16,14 @@ namespace PokemonAutomation{
 class FatalProgramException : public ScreenshotException{
 public:
     using ScreenshotException::ScreenshotException;
-    FatalProgramException(ScreenshotException&& e);
+    FatalProgramException(ScreenshotException&& e)
+        : ScreenshotException(
+            e.m_send_error_report,
+            std::move(e.m_message),
+            e.m_console,
+            std::move(e.m_screenshot)
+        )
+    {}
 
     virtual const char* name() const override{ return "FatalProgramException"; }
 };

SerialPrograms/Source/CommonFramework/Exceptions/FatalProgramException.h

@@ -7,25 +7,37 @@
 #ifndef PokemonAutomation_OperationFailedException_H
 #define PokemonAutomation_OperationFailedException_H
 
-#include <memory>
+#include "CommonFramework/Tools/ConsoleHandle.h"
 #include "ScreenshotException.h"
 
 namespace PokemonAutomation{
 
-class FatalProgramException;
-
 
 //  Thrown by subroutines if they fail for an in-game reason.
 //  These include recoverable errors which can be consumed by the program.
 class OperationFailedException : public ScreenshotException{
 public:
     using ScreenshotException::ScreenshotException;
-    explicit OperationFailedException(ErrorReport error_report, Logger& logger, std::string message);
-    explicit OperationFailedException(ErrorReport error_report, Logger& logger, std::string message, std::shared_ptr<const ImageRGB32> screenshot);
-    explicit OperationFailedException(ErrorReport error_report, ConsoleHandle& console, std::string message, bool take_screenshot);
 
-    virtual const char* name() const override{ return "OperationFailedException"; }
+    //  This is the most common use case. Throw and log exception.
+    //  Include console information for screenshot and stream history.
+    [[noreturn]] static void fire(
+        ConsoleHandle& console,
+        ErrorReport error_report,
+        std::string message
+    ){
+        throw_and_log<OperationFailedException>(console, error_report, std::move(message), console);
+    }
+    [[noreturn]] static void fire(
+        ConsoleHandle& console,
+        ErrorReport error_report,
+        std::string message,
+        std::shared_ptr<const ImageRGB32> screenshot
+    ){
+        throw_and_log<OperationFailedException>(console, error_report, std::move(message), &console, std::move(screenshot));
+    }
 
+    virtual const char* name() const override{ return "OperationFailedException"; }
 };
 
 

SerialPrograms/Source/CommonFramework/Exceptions/OliveActionFailedException.cpp

@@ -4,6 +4,7 @@
  *
  */
 
+#include "CommonFramework/ImageTypes/ImageRGB32.h"
 #include "CommonFramework/Notifications/ProgramNotifications.h"
 #include "CommonFramework/Tools/ProgramEnvironment.h"
 #include "CommonFramework/Tools/ConsoleHandle.h"
@@ -13,41 +14,36 @@ namespace PokemonAutomation{
 
 
 ProgramFinishedException::ProgramFinishedException(){}
-ProgramFinishedException::ProgramFinishedException(Logger& logger, std::string message)
+ProgramFinishedException::ProgramFinishedException(std::string message)
     : ScreenshotException(ErrorReport::NO_ERROR_REPORT, std::move(message))
-{
-    logger.log(std::string(ProgramFinishedException::name()) + ": " + m_message, COLOR_BLUE);
+{}
+
+
+ProgramFinishedException::ProgramFinishedException(
+    std::string message,
+    ConsoleHandle& console
+)
+    : ScreenshotException(ErrorReport::NO_ERROR_REPORT, std::move(message), console)
+{}
+ProgramFinishedException::ProgramFinishedException(
+    ErrorReport error_report,
+    std::string message,
+    ConsoleHandle* console,
+    ImageRGB32 screenshot
+)
+    : ScreenshotException(ErrorReport::NO_ERROR_REPORT, std::move(message), console, std::move(screenshot))
+{}
+ProgramFinishedException::ProgramFinishedException(
+    std::string message,
+    ConsoleHandle* console,
+    std::shared_ptr<const ImageRGB32> screenshot
+)
+    : ScreenshotException(ErrorReport::NO_ERROR_REPORT, std::move(message), console, std::move(screenshot))
+{}
+
+void ProgramFinishedException::log(Logger& logger) const{
+    logger.log(std::string(name()) + ": " + message(), COLOR_BLUE);
 }
-ProgramFinishedException::ProgramFinishedException(Logger& logger, std::string message, std::shared_ptr<const ImageRGB32> screenshot)
-    : ScreenshotException(ErrorReport::NO_ERROR_REPORT, std::move(message), std::move(screenshot))
-{
-    logger.log(std::string(ProgramFinishedException::name()) + " (with screenshot): " + m_message, COLOR_BLUE);
-}
-ProgramFinishedException::ProgramFinishedException(ConsoleHandle& console, std::string message, bool take_screenshot)
-    : ScreenshotException(ErrorReport::NO_ERROR_REPORT, console, std::move(message), take_screenshot)
-{
-    if (take_screenshot){
-        console.log(std::string(ProgramFinishedException::name()) + " (take screenshot): " + m_message, COLOR_BLUE);
-    }else{
-        console.log(std::string(ProgramFinishedException::name()) + " (no screenshot): " + m_message, COLOR_BLUE);
-    }
-}
-
-
-void ProgramFinishedException::send_notification(ProgramEnvironment& env, EventNotificationOption& notification) const{
-    std::vector<std::pair<std::string, std::string>> embeds;
-    if (!m_message.empty()){
-        embeds.emplace_back(std::pair<std::string, std::string>("Message:", m_message));
-    }
-    send_program_notification(
-        env, notification,
-        COLOR_GREEN,
-        "Program Finished",
-        std::move(embeds), "",
-        screenshot()
-    );
-}
-
 
 
 

SerialPrograms/Source/CommonFramework/Exceptions/OperationFailedException.cpp

@@ -27,15 +27,34 @@ class ConsoleHandle;
 class ProgramFinishedException : public ScreenshotException{
 public:
     ProgramFinishedException();
-    explicit ProgramFinishedException(Logger& logger, std::string message);
-    explicit ProgramFinishedException(Logger& logger, std::string message, std::shared_ptr<const ImageRGB32> screenshot);
-    explicit ProgramFinishedException(ConsoleHandle& console, std::string message, bool take_screenshot);
+    explicit ProgramFinishedException(std::string message);
+
+    //  Construct exception with message and console information.
+    //  This will take a screenshot and store the console if the stream history if requested later.
+    explicit ProgramFinishedException(
+        std::string message,
+        ConsoleHandle& console
+    );
+
+    //  Construct exception with message with screenshot and (optionally) console information.
+    //  Use the provided screenshot instead of taking one with the console.
+    //  Store the console information (if provided) for stream history if requested later.
+    explicit ProgramFinishedException(
+        ErrorReport error_report,
+        std::string message,
+        ConsoleHandle* console,
+        ImageRGB32 screenshot
+    );
+    explicit ProgramFinishedException(
+        std::string message,
+        ConsoleHandle* console,
+        std::shared_ptr<const ImageRGB32> screenshot
+    );
+
 
 public:
+    virtual void log(Logger& logger) const override;
     virtual const char* name() const override{ return "ProgramFinishedException"; }
-    virtual std::string message() const override{ return m_message; }
-
-    virtual void send_notification(ProgramEnvironment& env, EventNotificationOption& notification) const override;
 };