mirror of
https://github.com/RGBCube/serenity
synced 2025-07-26 06:37:35 +00:00
AK: Implement and test DistinctNumeric class
This template class allows for easy generation of incompatible numeric types. This is useful whenever code has to handle heterogenous data (like meters and seconds) but the underlying data types are compatible (like int and int). The motivation comes from the Kernel's inconsistent use of pid_t for process and thread IDs even though the ID spaces are incompatible, and translating forth/back is nontrivial. Other uses could be units (as described above), or incompatible index systems. A popular use in real life is image manipulation, when there are multiple coordinate systems.
This commit is contained in:
Ben Wiederhake
Andreas Kling
parent
54c6886108
commit
cc6d5242d1
2 changed files with 623 additions and 0 deletions
315
AK/Tests/TestDistinctNumeric.cpp
Normal file
315
AK/Tests/TestDistinctNumeric.cpp
Normal file
|
|
@ -0,0 +1,315 @@
|
|||
/*
|
||||
* Copyright (c) 2020, Ben Wiederhake <BenWiederhake.GitHub@gmx.de>
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#include <AK/DistinctNumeric.h>
|
||||
#include <AK/TestSuite.h>
|
||||
|
||||
template<typename T>
|
||||
class ForType {
|
||||
public:
|
||||
static void check_size()
|
||||
{
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(T, false, false, false, false, false, false, TheNumeric);
|
||||
EXPECT_EQ(sizeof(T), sizeof(TheNumeric));
|
||||
}
|
||||
};
|
||||
|
||||
TEST_CASE(check_size)
|
||||
{
|
||||
#define CHECK_SIZE_FOR_SIGNABLE(T) \
|
||||
do { \
|
||||
ForType<signed T>::check_size(); \
|
||||
ForType<unsigned T>::check_size(); \
|
||||
} while (false)
|
||||
CHECK_SIZE_FOR_SIGNABLE(char);
|
||||
CHECK_SIZE_FOR_SIGNABLE(short);
|
||||
CHECK_SIZE_FOR_SIGNABLE(int);
|
||||
CHECK_SIZE_FOR_SIGNABLE(long);
|
||||
CHECK_SIZE_FOR_SIGNABLE(long long);
|
||||
ForType<float>::check_size();
|
||||
ForType<double>::check_size();
|
||||
}
|
||||
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(int, false, false, false, false, false, false, BareNumeric);
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(int, true, false, false, false, false, false, IncrNumeric);
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(int, false, true, false, false, false, false, CmpNumeric);
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(int, false, false, true, false, false, false, BoolNumeric);
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(int, false, false, false, true, false, false, FlagsNumeric);
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(int, false, false, false, false, true, false, ShiftNumeric);
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(int, false, false, false, false, false, true, ArithNumeric);
|
||||
TYPEDEF_DISTINCT_NUMERIC_GENERAL(int, true, true, true, true, true, true, GeneralNumeric);
|
||||
|
||||
TEST_CASE(address_identity)
|
||||
{
|
||||
BareNumeric a = 4;
|
||||
BareNumeric b = 5;
|
||||
EXPECT_EQ(&a == &a, true);
|
||||
EXPECT_EQ(&a == &b, false);
|
||||
EXPECT_EQ(&a != &a, false);
|
||||
EXPECT_EQ(&a != &b, true);
|
||||
}
|
||||
|
||||
TEST_CASE(operator_identity)
|
||||
{
|
||||
BareNumeric a = 4;
|
||||
BareNumeric b = 5;
|
||||
EXPECT_EQ(a == a, true);
|
||||
EXPECT_EQ(a == b, false);
|
||||
EXPECT_EQ(a != a, false);
|
||||
EXPECT_EQ(a != b, true);
|
||||
}
|
||||
|
||||
TEST_CASE(operator_incr)
|
||||
{
|
||||
IncrNumeric a = 4;
|
||||
IncrNumeric b = 5;
|
||||
IncrNumeric c = 6;
|
||||
EXPECT_EQ(++a, b);
|
||||
EXPECT_EQ(a++, b);
|
||||
EXPECT_EQ(a, c);
|
||||
EXPECT_EQ(--a, b);
|
||||
EXPECT_EQ(a--, b);
|
||||
EXPECT(a != b);
|
||||
}
|
||||
|
||||
TEST_CASE(operator_cmp)
|
||||
{
|
||||
CmpNumeric a = 4;
|
||||
CmpNumeric b = 5;
|
||||
CmpNumeric c = 5;
|
||||
EXPECT_EQ(a > b, false);
|
||||
EXPECT_EQ(a < b, true);
|
||||
EXPECT_EQ(a >= b, false);
|
||||
EXPECT_EQ(a <= b, true);
|
||||
EXPECT_EQ(b > a, true);
|
||||
EXPECT_EQ(b < a, false);
|
||||
EXPECT_EQ(b >= a, true);
|
||||
EXPECT_EQ(b <= a, false);
|
||||
EXPECT_EQ(b > c, false);
|
||||
EXPECT_EQ(b < c, false);
|
||||
EXPECT_EQ(b >= c, true);
|
||||
EXPECT_EQ(b <= c, true);
|
||||
}
|
||||
|
||||
TEST_CASE(operator_bool)
|
||||
{
|
||||
BoolNumeric a = 0;
|
||||
BoolNumeric b = 42;
|
||||
BoolNumeric c = 1337;
|
||||
EXPECT_EQ(!a, true);
|
||||
EXPECT_EQ(!b, false);
|
||||
EXPECT_EQ(!c, false);
|
||||
EXPECT_EQ(a && b, false);
|
||||
EXPECT_EQ(a && c, false);
|
||||
EXPECT_EQ(b && c, true);
|
||||
EXPECT_EQ(a || a, false);
|
||||
EXPECT_EQ(a || b, true);
|
||||
EXPECT_EQ(a || c, true);
|
||||
EXPECT_EQ(b || c, true);
|
||||
}
|
||||
|
||||
TEST_CASE(operator_flags)
|
||||
{
|
||||
FlagsNumeric a = 0;
|
||||
FlagsNumeric b = 0xA60;
|
||||
FlagsNumeric c = 0x03B;
|
||||
EXPECT_EQ(~a, FlagsNumeric(~0x0));
|
||||
EXPECT_EQ(~b, FlagsNumeric(~0xA60));
|
||||
EXPECT_EQ(~c, FlagsNumeric(~0x03B));
|
||||
|
||||
EXPECT_EQ(a & b, b & a);
|
||||
EXPECT_EQ(a & c, c & a);
|
||||
EXPECT_EQ(b & c, c & b);
|
||||
EXPECT_EQ(a | b, b | a);
|
||||
EXPECT_EQ(a | c, c | a);
|
||||
EXPECT_EQ(b | c, c | b);
|
||||
EXPECT_EQ(a ^ b, b ^ a);
|
||||
EXPECT_EQ(a ^ c, c ^ a);
|
||||
EXPECT_EQ(b ^ c, c ^ b);
|
||||
|
||||
EXPECT_EQ(a & b, FlagsNumeric(0x000));
|
||||
EXPECT_EQ(a & c, FlagsNumeric(0x000));
|
||||
EXPECT_EQ(b & c, FlagsNumeric(0x020));
|
||||
EXPECT_EQ(a | b, FlagsNumeric(0xA60));
|
||||
EXPECT_EQ(a | c, FlagsNumeric(0x03B));
|
||||
EXPECT_EQ(b | c, FlagsNumeric(0xA7B));
|
||||
EXPECT_EQ(a ^ b, FlagsNumeric(0xA60));
|
||||
EXPECT_EQ(a ^ c, FlagsNumeric(0x03B));
|
||||
EXPECT_EQ(b ^ c, FlagsNumeric(0xA5B));
|
||||
|
||||
EXPECT_EQ(a &= b, FlagsNumeric(0x000));
|
||||
EXPECT_EQ(a, FlagsNumeric(0x000));
|
||||
EXPECT_EQ(a |= b, FlagsNumeric(0xA60));
|
||||
EXPECT_EQ(a, FlagsNumeric(0xA60));
|
||||
EXPECT_EQ(a &= c, FlagsNumeric(0x020));
|
||||
EXPECT_EQ(a, FlagsNumeric(0x020));
|
||||
EXPECT_EQ(a ^= b, FlagsNumeric(0xA40));
|
||||
EXPECT_EQ(a, FlagsNumeric(0xA40));
|
||||
|
||||
EXPECT_EQ(b, FlagsNumeric(0xA60));
|
||||
EXPECT_EQ(c, FlagsNumeric(0x03B));
|
||||
}
|
||||
|
||||
TEST_CASE(operator_shift)
|
||||
{
|
||||
ShiftNumeric a = 0x040;
|
||||
EXPECT_EQ(a << ShiftNumeric(0), ShiftNumeric(0x040));
|
||||
EXPECT_EQ(a << ShiftNumeric(1), ShiftNumeric(0x080));
|
||||
EXPECT_EQ(a << ShiftNumeric(2), ShiftNumeric(0x100));
|
||||
EXPECT_EQ(a >> ShiftNumeric(0), ShiftNumeric(0x040));
|
||||
EXPECT_EQ(a >> ShiftNumeric(1), ShiftNumeric(0x020));
|
||||
EXPECT_EQ(a >> ShiftNumeric(2), ShiftNumeric(0x010));
|
||||
|
||||
EXPECT_EQ(a <<= ShiftNumeric(5), ShiftNumeric(0x800));
|
||||
EXPECT_EQ(a, ShiftNumeric(0x800));
|
||||
EXPECT_EQ(a >>= ShiftNumeric(8), ShiftNumeric(0x008));
|
||||
EXPECT_EQ(a, ShiftNumeric(0x008));
|
||||
}
|
||||
|
||||
TEST_CASE(operator_arith)
|
||||
{
|
||||
ArithNumeric a = 12;
|
||||
ArithNumeric b = 345;
|
||||
EXPECT_EQ(a + b, ArithNumeric(357));
|
||||
EXPECT_EQ(b + a, ArithNumeric(357));
|
||||
EXPECT_EQ(a - b, ArithNumeric(-333));
|
||||
EXPECT_EQ(b - a, ArithNumeric(333));
|
||||
EXPECT_EQ(+a, ArithNumeric(12));
|
||||
EXPECT_EQ(-a, ArithNumeric(-12));
|
||||
EXPECT_EQ(a * b, ArithNumeric(4140));
|
||||
EXPECT_EQ(b * a, ArithNumeric(4140));
|
||||
EXPECT_EQ(a / b, ArithNumeric(0));
|
||||
EXPECT_EQ(b / a, ArithNumeric(28));
|
||||
EXPECT_EQ(a % b, ArithNumeric(12));
|
||||
EXPECT_EQ(b % a, ArithNumeric(9));
|
||||
|
||||
EXPECT_EQ(a += a, ArithNumeric(24));
|
||||
EXPECT_EQ(a, ArithNumeric(24));
|
||||
EXPECT_EQ(a *= a, ArithNumeric(576));
|
||||
EXPECT_EQ(a, ArithNumeric(576));
|
||||
EXPECT_EQ(a /= a, ArithNumeric(1));
|
||||
EXPECT_EQ(a, ArithNumeric(1));
|
||||
EXPECT_EQ(a %= a, ArithNumeric(0));
|
||||
EXPECT_EQ(a, ArithNumeric(0));
|
||||
}
|
||||
|
||||
TEST_CASE(composability)
|
||||
{
|
||||
GeneralNumeric a = 0;
|
||||
GeneralNumeric b = 1;
|
||||
// Ident
|
||||
EXPECT_EQ(a == a, true);
|
||||
EXPECT_EQ(a == b, false);
|
||||
// Incr
|
||||
EXPECT_EQ(++a, b);
|
||||
EXPECT_EQ(a--, b);
|
||||
EXPECT_EQ(a == b, false);
|
||||
// Cmp
|
||||
EXPECT_EQ(a < b, true);
|
||||
EXPECT_EQ(a >= b, false);
|
||||
// Bool
|
||||
EXPECT_EQ(!a, true);
|
||||
EXPECT_EQ(a && b, false);
|
||||
EXPECT_EQ(a || b, true);
|
||||
// Flags
|
||||
EXPECT_EQ(a & b, GeneralNumeric(0));
|
||||
EXPECT_EQ(a | b, GeneralNumeric(1));
|
||||
// Shift
|
||||
EXPECT_EQ(b << GeneralNumeric(4), GeneralNumeric(0x10));
|
||||
EXPECT_EQ(b >> b, GeneralNumeric(0));
|
||||
// Arith
|
||||
EXPECT_EQ(-b, GeneralNumeric(-1));
|
||||
EXPECT_EQ(a + b, b);
|
||||
EXPECT_EQ(b * GeneralNumeric(42), GeneralNumeric(42));
|
||||
}
|
||||
|
||||
/*
|
||||
* FIXME: These `negative_*` tests should cause precisely one compilation error
|
||||
* each, and always for the specified reason. Currently we do not have a harness
|
||||
* for that, so in order to run the test you need to set the #define to 1, compile
|
||||
* it, and check the error messages manually.
|
||||
*/
|
||||
#define COMPILE_NEGATIVE_TESTS 0
|
||||
#if COMPILE_NEGATIVE_TESTS
|
||||
TEST_CASE(negative_incr)
|
||||
{
|
||||
BareNumeric a = 12;
|
||||
a++;
|
||||
// error: static assertion failed: 'a++' is only available for DistinctNumeric types with 'Incr'.
|
||||
}
|
||||
|
||||
TEST_CASE(negative_cmp)
|
||||
{
|
||||
BareNumeric a = 12;
|
||||
(void)(a < a);
|
||||
// error: static assertion failed: 'a<b' is only available for DistinctNumeric types with 'Cmp'.
|
||||
}
|
||||
|
||||
TEST_CASE(negative_bool)
|
||||
{
|
||||
BareNumeric a = 12;
|
||||
(void)!a;
|
||||
// error: static assertion failed: '!a', 'a&&b', 'a||b' and similar operators are only available for DistinctNumeric types with 'Bool'.
|
||||
}
|
||||
|
||||
TEST_CASE(negative_flags)
|
||||
{
|
||||
BareNumeric a = 12;
|
||||
(void)(a & a);
|
||||
// error: static assertion failed: 'a&b' is only available for DistinctNumeric types with 'Flags'.
|
||||
}
|
||||
|
||||
TEST_CASE(negative_shift)
|
||||
{
|
||||
BareNumeric a = 12;
|
||||
(void)(a << a);
|
||||
// error: static assertion failed: 'a<<b' is only available for DistinctNumeric types with 'Shift'.
|
||||
}
|
||||
|
||||
TEST_CASE(negative_arith)
|
||||
{
|
||||
BareNumeric a = 12;
|
||||
(void)(a + a);
|
||||
// error: static assertion failed: 'a+b' is only available for DistinctNumeric types with 'Arith'.
|
||||
}
|
||||
|
||||
TEST_CASE(negative_incompatible)
|
||||
{
|
||||
GeneralNumeric a = 12;
|
||||
ArithNumeric b = 345;
|
||||
// And this is the entire point of `DistinctNumeric`:
|
||||
// Theoretically, the operation *could* be supported, but we declared those int types incompatible.
|
||||
(void)(a + b);
|
||||
// error: no match for ‘operator+’ (operand types are ‘GeneralNumeric’ {aka ‘AK::DistinctNumeric<int, true, true, true, true, true, true, 64, 64>’} and ‘ArithNumeric’ {aka ‘AK::DistinctNumeric<int, false, false, false, false, false, true, 64, 63>’})
|
||||
// 313 | (void)(a + b);
|
||||
// | ~ ^ ~
|
||||
// | | |
|
||||
// | | DistinctNumeric<[...],false,false,false,false,false,[...],[...],63>
|
||||
// | DistinctNumeric<[...],true,true,true,true,true,[...],[...],64>
|
||||
}
|
||||
#endif /* COMPILE_NEGATIVE_TESTS */
|
||||
|
||||
TEST_MAIN(DistinctNumeric)
|
||||
Loading…
Add table
Add a link
Reference in a new issue