blob: 03b6e8ea77a7ca7bddeaf1503d02b7f5fba44d85 (
plain)
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
|
/*
* 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 cmd_helper.h Helper functions to extract data from command parameters. */
#ifndef CMD_HELPER_H
#define CMD_HELPER_H
#include "core/enum_type.hpp"
#include "core/bitmath_func.hpp"
/**
* Extracts a given type from a value.
* @tparam T The type of data we're looking for.
* @tparam S The offset in the data.
* @tparam N The amount of bits to read.
* @tparam U The type of data passed to us.
* @param v The data to extract the value from.
*/
template<typename T, uint S, uint N, typename U> static inline T Extract(U v)
{
/* Check if there are enough bits in v */
static_assert(N == EnumPropsT<T>::num_bits);
static_assert(S + N <= sizeof(U) * 8);
static_assert(EnumPropsT<T>::end <= (1 << N));
U masked = GB(v, S, N);
return IsInsideMM(masked, EnumPropsT<T>::begin, EnumPropsT<T>::end) ? (T)masked : EnumPropsT<T>::invalid;
}
/**
* Check if an enum value is inside it's valid values.
* @tparam T Type of enum.
* @param v The value to validate
* @return True if enum is valid.
*/
template <typename T> static constexpr inline bool IsEnumValid(T v) noexcept
{
return IsInsideMM(v, EnumPropsT<T>::begin, EnumPropsT<T>::end);
}
#endif /* CMD_HELPER_H */
|
