C_timer.hpp

/*
 * Copyright 2024 Guillaume Guillet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _FGE_C_TIMER_HPP_INCLUDED
#define _FGE_C_TIMER_HPP_INCLUDED
 
#include "FastEngine/fge_extern.hpp"
#include "FastEngine/C_callback.hpp"
#include <chrono>
#include <mutex>
#include <string>
 
namespace fge
{
 
class FGE_API Timer
{
public:
    Timer(fge::Timer const& timer);
    Timer(fge::Timer&& timer) noexcept;
 
    explicit Timer(std::chrono::milliseconds const& goal);
    Timer(std::chrono::milliseconds const& goal, bool paused);
    Timer(std::chrono::milliseconds const& goal, std::string name, bool paused);
 
    void setName(std::string const& name);
    std::string const& getName() const;
 
    void setGoalDuration(std::chrono::milliseconds const& t);
    void addToGoal(std::chrono::milliseconds const& t);
    void subToGoal(std::chrono::milliseconds const& t);
 
    void setElapsedTime(std::chrono::milliseconds const& t);
    void addToElapsedTime(std::chrono::milliseconds const& t);
    void subToElapsedTime(std::chrono::milliseconds const& t);
 
    std::chrono::steady_clock::time_point const& getLifeTimePoint() const;
    std::chrono::milliseconds getLifeDuration() const;
 
    std::chrono::milliseconds const& getElapsedTime() const;
    std::chrono::milliseconds const& getGoalDuration() const;
 
    std::chrono::milliseconds getTimeLeft() const;
 
    bool goalReached() const;
    void restart();
 
    void pause();
    void resume();
    bool isPaused() const;
 
    fge::CallbackHandler<fge::Timer&> _onTimeReached; 
 
private:
    std::chrono::steady_clock::time_point const g_lifeTimePoint;
 
    std::chrono::milliseconds g_elapsedTime;
    std::chrono::milliseconds g_goalDuration;
 
    bool g_isPaused;
 
    std::string g_name;
 
    mutable std::mutex g_mutex;
};
 
} // namespace fge
 
#endif // _FGE_C_TIMER_HPP_INCLUDED