Files
@ r27407:1787a47352b7
Branch filter:
Location: cpp/openttd-patchpack/source/src/timer/timer.h
r27407:1787a47352b7
5.1 KiB
text/x-c
Codechange: prevent using (f)printf/(f)puts over fmt::print
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | /*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file timer.h Definition of Interval and OneShot timers */
#ifndef TIMER_H
#define TIMER_H
#include "timer_manager.h"
/**
* The base where every other type of timer is derived from.
*
* Never use this class directly yourself.
*/
template <typename TTimerType>
class BaseTimer {
public:
using TPeriod = typename TTimerType::TPeriod;
using TElapsed = typename TTimerType::TElapsed;
using TStorage = typename TTimerType::TStorage;
/**
* Create a new timer.
*
* @param period The period of the timer.
*/
NODISCARD BaseTimer(const TPeriod period) :
period(period)
{
TimerManager<TTimerType>::RegisterTimer(*this);
}
/**
* Delete the timer.
*/
virtual ~BaseTimer()
{
TimerManager<TTimerType>::UnregisterTimer(*this);
}
/* Although these variables are public, they are only public to make saveload easier; not for common use. */
TPeriod period; ///< The period of the timer.
TStorage storage = {}; ///< The storage of the timer.
protected:
/**
* Called by the timer manager to notify the timer that the given amount of time has elapsed.
*
* @param delta Depending on the time type, this is either in milliseconds or in ticks.
*/
virtual void Elapsed(TElapsed delta) = 0;
/* To ensure only TimerManager can access Elapsed. */
friend class TimerManager<TTimerType>;
};
/**
* An interval timer will fire every interval, and will continue to fire until it is deleted.
*
* The callback receives how many times the timer has fired since the last time it fired.
* It will always try to fire every interval, but in times of severe stress it might be late.
*
* Each Timer-type needs to implement the Elapsed() method, and call the callback if needed.
*
* Setting the period to zero disables the interval. It can be reenabled at any time by
* calling SetInterval() with a non-zero period.
*/
template <typename TTimerType>
class IntervalTimer : public BaseTimer<TTimerType> {
public:
using TPeriod = typename TTimerType::TPeriod;
using TElapsed = typename TTimerType::TElapsed;
/**
* Create a new interval timer.
*
* @param interval The interval between each callback.
* @param callback The callback to call when the interval has passed.
*/
NODISCARD IntervalTimer(const TPeriod interval, std::function<void(uint)> callback) :
BaseTimer<TTimerType>(interval),
callback(callback)
{
}
/**
* Set a new interval for the timer.
*
* @param interval The interval between each callback.
* @param reset Whether to reset the timer to zero.
*/
void SetInterval(const TPeriod interval, bool reset = true)
{
this->period = interval;
if (reset) this->storage = {};
}
private:
std::function<void(uint)> callback;
void Elapsed(TElapsed count) override;
};
/**
* A timeout timer will fire once after the interval. You can reset it to fire again.
* The timer will never fire before the interval has passed, but in times of severe stress it might be late.
*/
template <typename TTimerType>
class TimeoutTimer : public BaseTimer<TTimerType> {
public:
using TPeriod = typename TTimerType::TPeriod;
using TElapsed = typename TTimerType::TElapsed;
/**
* Create a new timeout timer.
*
* By default the timeout starts aborted; you will have to call Reset() before it starts.
*
* @param timeout The timeout after which the timer will fire.
* @param callback The callback to call when the timeout has passed.
* @param start Whether to start the timer immediately. If false, you can call Reset() to start it.
*/
NODISCARD TimeoutTimer(const TPeriod timeout, std::function<void()> callback, bool start = false) :
BaseTimer<TTimerType>(timeout),
fired(!start),
callback(callback)
{
}
/**
* Reset the timer, so it will fire again after the timeout.
*/
void Reset()
{
this->fired = false;
this->storage = {};
}
/**
* Reset the timer, so it will fire again after the timeout.
*
* @param timeout Set a new timeout for the next trigger.
*/
void Reset(const TPeriod timeout)
{
this->period = timeout;
this->fired = false;
this->storage = {};
}
/**
* Abort the timer so it doesn't fire if it hasn't yet.
*/
void Abort()
{
this->fired = true;
}
/**
* Check whether the timeout occurred.
*
* @return True iff the timeout occurred.
*/
bool HasFired() const
{
return this->fired;
}
/* Although these variables are public, they are only public to make saveload easier; not for common use. */
bool fired; ///< Whether the timeout has occurred.
private:
std::function<void()> callback;
void Elapsed(TElapsed count) override;
};
#endif /* TIMER_H */
|