Magic_Game/Easy2D/base/time.h

// Copyright (c) 2016-2018 Easy2D - Nomango
// 
// 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 "../macros.h"

namespace easy2d
{
	namespace time
	{
		// 时间段
		//
		// 时间段表示法:
		//     5 秒: time::Second * 5
		//     1.5 小时: time::Hour * 1.5
		//     3 小时 45 分 15 秒: time::Hour * 3 + time::Minute * 45 + time::Second * 15
		// 在 VS2015 及更高版本可以使用 time literals:
		//     5 秒: 5_s
		//     1.5 小时: 1.5_h
		//     3 小时 45 分 15 秒: 3_h + 45_m + 15_s
		//
		struct E2D_API Duration
		{
			Duration();

			Duration(
				long milliseconds
			);

			// 转化为毫秒
			inline long Milliseconds() const { return milliseconds_; }

			// 转化为秒
			float Seconds() const;

			// 转化为分钟
			float Minutes() const;

			// 转化为小时
			float Hours() const;

			// 时长是否是零
			inline bool IsZero() const { return milliseconds_ == 0LL; }

			// 转为字符串
			std::wstring ToString() const;

			inline operator bool() const { return !IsZero(); }

			bool operator== (const Duration &) const;
			bool operator!= (const Duration &) const;
			bool operator> (const Duration &) const;
			bool operator>= (const Duration &) const;
			bool operator< (const Duration &) const;
			bool operator<= (const Duration &) const;

			float operator / (const Duration &) const;

			const Duration operator + (const Duration &) const;
			const Duration operator - (const Duration &) const;
			const Duration operator - () const;
			const Duration operator * (int) const;
			const Duration operator * (unsigned long long) const;
			const Duration operator * (float) const;
			const Duration operator * (double) const;
			const Duration operator * (long double) const;
			const Duration operator / (int) const;
			const Duration operator / (float) const;
			const Duration operator / (double) const;

			Duration& operator += (const Duration &);
			Duration& operator -= (const Duration &);
			Duration& operator *= (int);
			Duration& operator *= (float);
			Duration& operator *= (double);
			Duration& operator /= (int);
			Duration& operator /= (float);
			Duration& operator /= (double);

			friend const Duration operator* (int, const Duration &);
			friend const Duration operator* (float, const Duration &);
			friend const Duration operator* (double, const Duration &);
			friend const Duration operator* (long double, const Duration &);
			friend const Duration operator/ (int, const Duration &);
			friend const Duration operator/ (float, const Duration &);
			friend const Duration operator/ (double, const Duration &);

			friend std::wostream& operator<< (std::wostream &, const Duration &);
			friend std::wistream& operator>> (std::wistream &, Duration &);

		private:
			long milliseconds_;
		};

		/* 预定义的时间段 */
		E2D_API extern const Duration Millisecond;	// 毫秒
		E2D_API extern const Duration Second;		// 秒
		E2D_API extern const Duration Minute;		// 分钟
		E2D_API extern const Duration Hour;			// 小时


		// 时间
		//
		// 获取当前时间: TimePoint now = time::Now();
		// 两时间相减, 得到一个 Duration 对象, 例如:
		//     TimePoint t1, t2;
		//     int ms = (t2 - t1).Milliseconds();  // 获取两时间相差的毫秒数
		// 
		struct E2D_API TimePoint
		{
			TimePoint();

			TimePoint(long);

			// 是否是零时
			inline bool IsZero() const { return dur_ == 0; }

			const TimePoint operator + (const Duration &) const;
			const TimePoint operator - (const Duration &) const;

			TimePoint& operator += (const Duration &);
			TimePoint& operator -= (const Duration &);

			const Duration operator - (const TimePoint &) const;

		private:
			long dur_;
		};

		// 获取当前时间
		// 
		// 由于该时间点基于系统启动时间开始计算, 所以无法格式化该时间, 
		// 也无法获得该时间的 Unix 时间戳
		E2D_API TimePoint Now() E2D_NOEXCEPT;

		// 时间段格式化
		//
		// 时间段字符串允许是有符号的浮点数, 并且带有时间单位后缀
		// 例如: "300ms", "-1.5h", "2h45m"
		// 允许的时间单位有 "ms", "s", "m", "h"
		E2D_API Duration ParseDuration(const std::wstring& parse_str);
	}
}

namespace easy2d
{
	using namespace time;
}

#if VS_VER >= VS_2015

namespace easy2d
{
	inline namespace literals
	{
		inline const easy2d::time::Duration operator "" _ms(long double val)
		{
			return easy2d::time::Millisecond * val;
		}

		inline const easy2d::time::Duration operator "" _s(long double val)
		{
			return easy2d::time::Second * val;
		}

		inline const easy2d::time::Duration operator "" _m(long double val)
		{
			return easy2d::time::Minute * val;
		}

		inline const easy2d::time::Duration operator "" _h(long double val)
		{
			return easy2d::time::Hour * val;
		}

		inline const easy2d::time::Duration operator "" _ms(unsigned long long val)
		{
			return easy2d::time::Millisecond * val;
		}

		inline const easy2d::time::Duration operator "" _s(unsigned long long val)
		{
			return easy2d::time::Second * val;
		}

		inline const easy2d::time::Duration operator "" _m(unsigned long long val)
		{
			return easy2d::time::Minute * val;
		}

		inline const easy2d::time::Duration operator "" _h(unsigned long long val)
		{
			return easy2d::time::Hour * val;
		}
	}

	namespace time
	{
		using namespace easy2d::literals;
	}
}

#endif