Refactor error handling to separate library and CLI error messages (#237)

Signed-off-by: aabhinavvvvvvv <[email protected]>

Author: aabhinavvvvvvv

.github/workflows/build-steps.yml

@@ -85,7 +85,7 @@ jobs:
         if: inputs.vfxyear < 2024
         shell: bash
         run: |
-          build_scripts/${{ inputs.install_deps }}.bash
+          bash build_scripts/${{ inputs.install_deps }}.bash
               
       - name: Dependencies (aswf/ci-rawtoaces)
         if: inputs.vfxyear > 2023

.github/workflows/coverage.yml

@@ -18,7 +18,7 @@ jobs:
     - name: Install OS dependencies
       shell: bash
       run: |
-        build_scripts/install_deps_mac.bash
+        bash build_scripts/install_deps_mac.bash
     
     - name: Install coverage dependencies
       run: |

build_scripts/install_aces_container.bash

@@ -25,6 +25,39 @@ collect_image_files( const std::vector<std::string> &paths );
 class ImageConverter
 {
 public:
+    /// Status codes for operation results.
+    enum class Status
+    {
+        /// Operation completed successfully.
+        Success,
+        /// Output file already exists and overwrite is not enabled.
+        FileExists,
+        /// Input file does not exist.
+        InputFileNotFound,
+        /// Empty input filename provided.
+        EmptyInputFilename,
+        /// Filesystem error occurred.
+        FilesystemError,
+        /// Output directory does not exist and cannot be created.
+        OutputDirectoryError,
+        /// Invalid path format.
+        InvalidPath,
+        /// Failed to configure the image reader.
+        ConfigurationError,
+        /// Failed to read the image file.
+        ReadError,
+        /// Failed to apply colour space conversion.
+        MatrixApplicationError,
+        /// Failed to apply scale.
+        ScaleApplicationError,
+        /// Failed to apply crop.
+        CropApplicationError,
+        /// Failed to save the output file.
+        WriteError,
+        /// Unknown error.
+        UnknownError
+    };
+
     /// The structure containing all parameters needed to configure image conversion.
     struct Settings
     {
@@ -211,6 +244,12 @@ class ImageConverter
     /// The conversion settings.
     Settings settings;
 
+    /// This property holds the error code from the most recent method call that returns a bool.
+    Status status = Status::Success;
+
+    /// Error message from the most recent method call that returned false.
+    std::string last_error_message;
+
     /// Initialise the parser object with all the command line parameters
     /// used by this tool. The method also sets the help and usage strings.
     /// The parser object can be amended by the calling code afterwards if

build_scripts/install_deps_linux.bash

@@ -18,6 +18,9 @@ void util_bindings( nanobind::module_ &m )
     image_converter.def( nanobind::init<>() );
 
     image_converter.def_rw( "settings", &ImageConverter::settings );
+    image_converter.def_ro( "status", &ImageConverter::status );
+    image_converter.def_rw(
+        "last_error_message", &ImageConverter::last_error_message );
     image_converter.def( "process_image", &ImageConverter::process_image );
     image_converter.def(
         "get_WB_multipliers", &ImageConverter::get_WB_multipliers );
@@ -224,4 +227,31 @@ void util_bindings( nanobind::module_ &m )
         .value( "Soft", ImageConverter::Settings::CropMode::Soft )
         .value( "Hard", ImageConverter::Settings::CropMode::Hard )
         .export_values();
+
+    nanobind::enum_<ImageConverter::Status>( image_converter, "Status" )
+        .value( "Success", ImageConverter::Status::Success )
+        .value( "FileExists", ImageConverter::Status::FileExists )
+        .value( "InputFileNotFound", ImageConverter::Status::InputFileNotFound )
+        .value(
+            "EmptyInputFilename", ImageConverter::Status::EmptyInputFilename )
+        .value( "FilesystemError", ImageConverter::Status::FilesystemError )
+        .value(
+            "OutputDirectoryError",
+            ImageConverter::Status::OutputDirectoryError )
+        .value( "InvalidPath", ImageConverter::Status::InvalidPath )
+        .value(
+            "ConfigurationError", ImageConverter::Status::ConfigurationError )
+        .value( "ReadError", ImageConverter::Status::ReadError )
+        .value(
+            "MatrixApplicationError",
+            ImageConverter::Status::MatrixApplicationError )
+        .value(
+            "ScaleApplicationError",
+            ImageConverter::Status::ScaleApplicationError )
+        .value(
+            "CropApplicationError",
+            ImageConverter::Status::CropApplicationError )
+        .value( "WriteError", ImageConverter::Status::WriteError )
+        .value( "UnknownError", ImageConverter::Status::UnknownError )
+        .export_values();
 }