/*
**  ClanLib SDK
**  Copyright (c) 1997-2020 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/

#pragma once

#include <memory>
#include <functional>

namespace clan
{
	class TimerImpl;

	/// \brief Timer class that invokes a callback on a specified interval
	class Timer
	{
	public:
		/// \brief Creates a timer object
		Timer();

		/// \brief Returns true if the timer repeats until it is stopped
		bool is_repeating() const;

		/// \brief Returns the current timeout. In milliseconds.
		unsigned int get_timeout() const;

		/// \brief Callback invoked every time the timer interval occurs
		std::function<void()> &func_expired();

		/// \brief Starts the timer. Timeout in milliseconds.
		void start(unsigned int timeout, bool repeat = true);

		/// \brief Stop the timer.
		void stop();

	private:
		std::shared_ptr<TimerImpl> impl;
	};
}
