Implement progress indicator

cmake/load_dependencies.cmake

@@ -3,7 +3,8 @@ find_package(magic_enum REQUIRED CONFIG)
 find_package(CLI11 REQUIRED CONFIG)
 find_package(Eigen3 REQUIRED CONFIG)
 find_package(GSL REQUIRED)
+find_package(indicators REQUIRED)
 
 if(ENABLE_TEST)
-    find_package(GTest CONFIG REQUIRED)
+  find_package(GTest CONFIG REQUIRED)
 endif()

conanfile.py

@@ -15,6 +15,7 @@ def requirements(self):
         self.requires("magic_enum/0.9.7")   # type: ignore
         self.requires("cli11/2.6.0")        # type: ignore
         self.requires("eigen/5.0.1")        # type: ignore
+        self.requires("indicators/2.3")     # type: ignore
 
         # Conditions on cmake variables set from cmake/project_options
         if os.environ["CMAKE_ENABLE_TEST"] == "ON":

source/centipede/reader/binary.cpp

@@ -224,6 +224,7 @@ namespace centipede::reader
         {
             return std::unexpected{ size.error() };
         }
+        last_entry_bytes_ = (read_size + 1U) * sizeof(uint32_t);
         ++n_entries_;
         size_ = size.value();
         return size.value();

source/centipede/reader/binary.hpp

@@ -7,6 +7,7 @@
 #include <cstddef>
 #include <cstdint>
 #include <expected>
+#include <filesystem>
 #include <fstream>
 #include <iterator>
 #include <span>
@@ -169,6 +170,15 @@ namespace centipede::reader
          */
         [[nodiscard]] constexpr auto get_n_entries() const -> std::size_t { return n_entries_; }
 
+        // TODO: Add documentation
+        [[nodiscard]] auto get_file_size() const -> std::size_t
+        {
+            return static_cast<std::size_t>(std::filesystem::file_size(config_.in_filename));
+        }
+
+        // TODO: Add documentation
+        [[nodiscard]] auto get_last_entry_bytes() const -> std::size_t { return last_entry_bytes_; }
+
         /**
          * @brief Checks if last read operation reached end of file.
          * @return Returns true if end of file is reached.
@@ -181,7 +191,7 @@ namespace centipede::reader
          * The status is updated during iteration and after manual read operations.
          *
          * @return
-         * - ErrorCode::invalid while iteration/reading is in progress.
+         * - ErrorCode::incomplete while iteration/reading is in progress.
          * - ErrorCode::success if iteration finished successfully.
          * - Any other ErrorCode if a read or parsing error occurred.
          */
@@ -235,7 +245,7 @@ namespace centipede::reader
             explicit Iterator(Binary* reader_ptr)
                 : reader_{ reader_ptr }
             {
-                reader_->status_ = ErrorCode::invalid;
+                reader_->status_ = ErrorCode::incomplete;
                 ++(*this);
             }
 
@@ -276,7 +286,7 @@ namespace centipede::reader
                 }
 
                 current_ = reader_->get_current_entry();
-                reader_->status_ = ErrorCode::invalid;
+                reader_->status_ = ErrorCode::incomplete;
                 return *this;
             }
             /**
@@ -296,7 +306,10 @@ namespace centipede::reader
              *
              * @return Returns true while iteration is not finished.
              */
-            auto operator!=(const Sentinel&) const -> bool { return reader_->status_ == ErrorCode::invalid; }
+            auto operator!=(const Sentinel&) const -> bool { return reader_->status_ == ErrorCode::incomplete; }
+
+            // TODO: add documentation
+            bool operator==(Sentinel) const { return reader_->status_ != ErrorCode::incomplete; }
 
           private:
             Binary* reader_{};    //!< Associated Binary reader instance.
@@ -324,8 +337,10 @@ namespace centipede::reader
         std::ifstream input_file_;       //!< Input file handler
         std::size_t size_{};             //!< Number of Entrypoints in the current entry
         std::size_t n_entries_{};        //!< Total number of entries read by this instance
-        bool end_of_file_{ false };      //!< Indicates if end of file is reached. Gets updated on read.
-        ErrorCode status_{ ErrorCode::invalid };
+        std::size_t last_entry_bytes_{}; // TODO: Add documentation
+
+        bool end_of_file_{ false }; //!< Indicates if end of file is reached. Gets updated on read.
+        ErrorCode status_{ ErrorCode::incomplete };
 
         void reset();
         auto read_entry_to_buffer(uint32_t read_size) -> EnumError<>;

source/centipede/util/CMakeLists.txt

@@ -3,5 +3,7 @@ target_sources(
     PUBLIC
         FILE_SET publicHeaders
             TYPE HEADERS
-            FILES common_traits.hpp error_types.hpp return_types.hpp
+            FILES common_traits.hpp error_types.hpp return_types.hpp progress_indicator.hpp
 )
+
+target_link_libraries(core PUBLIC indicators::indicators)

source/centipede/util/common_definitions.hpp

@@ -6,4 +6,5 @@ namespace centipede::common
 {
     constexpr auto DEFAULT_BUFFER_SIZE =
         std::size_t{ 10000 }; //!< Default maximum buffer size for binary readers/writers.
+    constexpr auto DEFAULT_INDICATOR_BAR_WIDTH = std::size_t{ 50 };
 } // namespace centipede::common

source/centipede/util/error_types.hpp

@@ -13,6 +13,7 @@ namespace centipede
         // TODO: duplication of comments
         invalid,                    //!< Error due to no evaluation!
         success,                    //!< No error. All good!
+        incomplete,                 //!< Operation incomplete!
         handler_incomp_n_locals,    //!< Incompatible number of local variables from the current entrypoint.
         writer_neg_or_zero_sigma,   //!< Zero or negative sigma occurs. See @ref writer::Binary.
         writer_buffer_overflow,     //!< Buffer size is too small for a new entry occurs. See @ref writer::Binary.
@@ -33,6 +34,9 @@ namespace centipede
         reader_uninitialized,        //!< Reader is not initialized.
         reader_buffer_overflow,      //!< Buffer size is too small for a new entry occurs. See @ref reader::Binary.
         reader_invalid_filename,     //!< Filename is invalid or empty
+        progress_zero_size,          //!< Given size is zero
+        progress_inc_exceeds_size,   //!< Increment exceeds given size
+        progress_inc_returns_zero    //!< Increment returns zero
     };
 
 } // namespace centipede
@@ -97,8 +101,16 @@ struct std::formatter<centipede::ErrorCode>
                 return std::format_to(ctx.out(), "Reader: Cannot read the file. Buffer size will be exceeded!");
             case reader_invalid_filename:
                 return std::format_to(ctx.out(), "Reader: Filename is either empty or invalid!");
+            case progress_zero_size:
+                return std::format_to(ctx.out(), "Progress: Given size is 0!");
+            case progress_inc_exceeds_size:
+                return std::format_to(ctx.out(), "Progress: Increment exceeds given size!");
+            case progress_inc_returns_zero:
+                return std::format_to(ctx.out(), "Progress: Increment returns 0!");
             case invalid:
                 return std::format_to(ctx.out(), "Error due to no evaluation!");
+            case incomplete:
+                return std::format_to(ctx.out(), "Operation incomplete!");
             default:
                 break;
         }