Merge pull request #1078 from Geode-solutions/feat/chrono

feat(Chronometer): start and stop timer

Author: MelchiorSchuh

include/geode/basic/chronometer.hpp

@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2019 - 2025 Geode-solutions
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+#pragma once
+
+#include <absl/time/time.h>
+
+#include <geode/basic/common.hpp>
+#include <geode/basic/pimpl.hpp>
+
+namespace geode
+{
+    class opengeode_basic_api Chronometer
+    {
+    public:
+        Chronometer();
+        Chronometer( Chronometer&& other ) noexcept;
+        ~Chronometer();
+
+        void start();
+
+        void stop();
+
+        [[nodiscard]] absl::Duration raw_duration() const;
+
+        [[nodiscard]] std::string duration() const;
+
+        void reset();
+
+    private:
+        IMPLEMENTATION_MEMBER( impl_ );
+    };
+} // namespace geode

src/geode/basic/CMakeLists.txt

@@ -28,6 +28,7 @@ add_geode_library(
         "bitsery_input.cpp"
         "bitsery_output.cpp"
         "cell_array.cpp"
+        "chronometer.cpp"
         "common.cpp"
         "console_logger_client.cpp"
         "console_progress_logger_client.cpp"
@@ -54,6 +55,7 @@ add_geode_library(
         "attribute.hpp"
         "bitsery_archive.hpp"
         "cell_array.hpp"
+        "chronometer.hpp"
         "common.hpp"
         "console_logger_client.hpp"
         "console_progress_logger_client.hpp"

src/geode/basic/chronometer.cpp

@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) 2019 - 2025 Geode-solutions
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+#include <geode/basic/chronometer.hpp>
+
+#include <absl/time/clock.h>
+
+#include <geode/basic/pimpl_impl.hpp>
+
+namespace geode
+{
+    class Chronometer::Impl
+    {
+    public:
+        void start()
+        {
+            start_time_ = absl::Now();
+        }
+
+        void stop()
+        {
+            duration_ += absl::Now() - start_time_;
+        }
+
+        [[nodiscard]] absl::Duration raw_duration() const
+        {
+            return duration_;
+        }
+
+        [[nodiscard]] std::string duration() const
+        {
+            return absl::FormatDuration( raw_duration() );
+        }
+
+        void reset()
+        {
+            duration_ = absl::ZeroDuration();
+        }
+
+    private:
+        absl::Time start_time_;
+        absl::Duration duration_;
+    };
+
+    Chronometer::Chronometer() = default;
+    Chronometer::Chronometer( Chronometer&& other ) noexcept = default;
+    Chronometer::~Chronometer() = default;
+
+    void Chronometer::start()
+    {
+        impl_->start();
+    }
+
+    void Chronometer::stop()
+    {
+        impl_->stop();
+    }
+
+    [[nodiscard]] absl::Duration Chronometer::raw_duration() const
+    {
+        return impl_->raw_duration();
+    }
+
+    [[nodiscard]] std::string Chronometer::duration() const
+    {
+        return impl_->duration();
+    }
+
+    void Chronometer::reset()
+    {
+        impl_->reset();
+    }
+} // namespace geode