git subrepo clone --branch=20.41.6 git@github.com:ETLCPP/etl.git components/etl
subrepo: subdir: "components/etl" merged: "be5537ec" upstream: origin: "git@github.com:ETLCPP/etl.git" branch: "20.41.6" commit: "be5537ec" git-subrepo: version: "0.4.9" origin: "???" commit: "???"
This commit is contained in:
parent
931c4def56
commit
11c24647ea
1296 changed files with 801882 additions and 0 deletions
576
components/etl/test/test_observer.cpp
Normal file
576
components/etl/test/test_observer.cpp
Normal file
|
@ -0,0 +1,576 @@
|
|||
/******************************************************************************
|
||||
The MIT License(MIT)
|
||||
|
||||
Embedded Template Library.
|
||||
https://github.com/ETLCPP/etl
|
||||
https://www.etlcpp.com
|
||||
|
||||
Copyright(c) 2014 John Wellbelove
|
||||
|
||||
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.
|
||||
******************************************************************************/
|
||||
|
||||
#include "unit_test_framework.h"
|
||||
|
||||
#include "etl/observer.h"
|
||||
|
||||
namespace
|
||||
{
|
||||
//*****************************************************************************
|
||||
// Notification1
|
||||
//*****************************************************************************
|
||||
struct Notification1
|
||||
{
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// Notification2
|
||||
//*****************************************************************************
|
||||
struct Notification2
|
||||
{
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// Notification3
|
||||
//*****************************************************************************
|
||||
struct Notification3
|
||||
{
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// Generic notification.
|
||||
//*****************************************************************************
|
||||
template <const int ID>
|
||||
struct Notification
|
||||
{
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// The observer base type.
|
||||
// Declare what notifications you want to observe and how they are passed to 'notification'.
|
||||
// The Notification1 is passed by value.
|
||||
// The Notification2 is passed by reference.
|
||||
// The Notification3 is passed by const reference.
|
||||
//*****************************************************************************
|
||||
typedef etl::observer<Notification1, Notification2&, const Notification3&> ObserverType;
|
||||
|
||||
//*****************************************************************************
|
||||
// The observer base type that does not take a notification type.
|
||||
//*****************************************************************************
|
||||
typedef etl::observer<void, int> ObserverVoidIntType;
|
||||
}
|
||||
|
||||
//*****************************************************************************
|
||||
// The concrete observable 1 class.
|
||||
//*****************************************************************************
|
||||
class Observable1 : public etl::observable<ObserverType, 2>
|
||||
{
|
||||
public:
|
||||
|
||||
Notification1 data1;
|
||||
Notification2 data2;
|
||||
Notification1& data3 = data1;
|
||||
|
||||
//*********************************
|
||||
// Notify all of the observers.
|
||||
//*********************************
|
||||
void send_notifications()
|
||||
{
|
||||
notify_observers(data3);
|
||||
notify_observers(data2);
|
||||
}
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// The concrete observable 2 class.
|
||||
//*****************************************************************************
|
||||
class Observable2 : public etl::observable<ObserverType, 2>
|
||||
{
|
||||
public:
|
||||
|
||||
Notification3 data3;
|
||||
|
||||
//*********************************
|
||||
// Notify all of the observers.
|
||||
//*********************************
|
||||
void send_notifications()
|
||||
{
|
||||
notify_observers(data3);
|
||||
}
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// The concrete observable 3 class.
|
||||
//*****************************************************************************
|
||||
class ObservableVoidInt : public etl::observable<ObserverVoidIntType, 2>
|
||||
{
|
||||
public:
|
||||
|
||||
//*********************************
|
||||
// Notify all of the observers.
|
||||
//*********************************
|
||||
void send_notifications()
|
||||
{
|
||||
notify_observers();
|
||||
}
|
||||
|
||||
//*********************************
|
||||
// Notify all of the observers.
|
||||
//*********************************
|
||||
void send_notifications(int n)
|
||||
{
|
||||
notify_observers(n);
|
||||
}
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// The first observer type.
|
||||
// If any one of the overloads is missing or a parameter declaration is incorrect
|
||||
// then the class will be 'abstract' and will not compile.
|
||||
//*****************************************************************************
|
||||
class Observer1 : public ObserverType
|
||||
{
|
||||
public:
|
||||
|
||||
Observer1()
|
||||
: data1_count(0)
|
||||
, data2_count(0)
|
||||
, data3_count(0)
|
||||
{
|
||||
}
|
||||
|
||||
//*******************************************
|
||||
// Notification1 is passed by value.
|
||||
//*******************************************
|
||||
void notification(Notification1 /*data1*/)
|
||||
{
|
||||
++data1_count;
|
||||
}
|
||||
|
||||
//*******************************************
|
||||
// Notification2 is passed by reference.
|
||||
//*******************************************
|
||||
void notification(Notification2& /*data2*/)
|
||||
{
|
||||
++data2_count;
|
||||
}
|
||||
|
||||
//*******************************************
|
||||
// Notification3 is passed by const reference.
|
||||
//*******************************************
|
||||
void notification(const Notification3& /*data3*/)
|
||||
{
|
||||
++data3_count;
|
||||
}
|
||||
|
||||
int data1_count;
|
||||
int data2_count;
|
||||
int data3_count;
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// The second observer type.
|
||||
// If any one of the overloads is missing or a parameter declaration is incorrect
|
||||
// then the class will be 'abstract' and will not compile.
|
||||
//*****************************************************************************
|
||||
class Observer2 : public ObserverType
|
||||
{
|
||||
public:
|
||||
|
||||
Observer2()
|
||||
: data1_count(0)
|
||||
, data2_count(0)
|
||||
, data3_count(0)
|
||||
{
|
||||
}
|
||||
|
||||
//*******************************************
|
||||
// Notification1 is passed by value.
|
||||
//*******************************************
|
||||
void notification(Notification1 /*data1*/)
|
||||
{
|
||||
++data1_count;
|
||||
}
|
||||
|
||||
//*******************************************
|
||||
// Notification2 is passed by reference.
|
||||
//*******************************************
|
||||
void notification(Notification2& /*data2*/)
|
||||
{
|
||||
++data2_count;
|
||||
}
|
||||
|
||||
//*******************************************
|
||||
// Notification3 is passed by const reference.
|
||||
//*******************************************
|
||||
void notification(const Notification3& /*data3*/)
|
||||
{
|
||||
++data3_count;
|
||||
}
|
||||
|
||||
int data1_count;
|
||||
int data2_count;
|
||||
int data3_count;
|
||||
};
|
||||
|
||||
//*****************************************************************************
|
||||
// The third observer type.
|
||||
// If any one of the overloads is missing or a parameter declaration is incorrect
|
||||
// then the class will be 'abstract' and will not compile.
|
||||
//*****************************************************************************
|
||||
class ObserverVoidInt : public ObserverVoidIntType
|
||||
{
|
||||
public:
|
||||
|
||||
ObserverVoidInt()
|
||||
: data1_count(0)
|
||||
, data2_count(0)
|
||||
{
|
||||
}
|
||||
|
||||
//*******************************************
|
||||
// Notification1
|
||||
//*******************************************
|
||||
void notification() override
|
||||
{
|
||||
++data1_count;
|
||||
}
|
||||
|
||||
//*******************************************
|
||||
// Notification2
|
||||
//*******************************************
|
||||
void notification(int) override
|
||||
{
|
||||
++data2_count;
|
||||
}
|
||||
|
||||
int data1_count;
|
||||
int data2_count;
|
||||
};
|
||||
|
||||
namespace
|
||||
{
|
||||
SUITE(test_observer)
|
||||
{
|
||||
//*************************************************************************
|
||||
TEST(test_2_observables_2_observers_3_notifications)
|
||||
{
|
||||
// The observable objects.
|
||||
Observable1 observable1;
|
||||
Observable2 observable2;
|
||||
|
||||
// The observer objects.
|
||||
Observer1 observer1;
|
||||
Observer2 observer2;
|
||||
|
||||
observable1.add_observer(observer1);
|
||||
|
||||
// Send the notifications.
|
||||
observable1.send_notifications(); // Updates data1 & data2.
|
||||
|
||||
CHECK_EQUAL(1, observer1.data1_count);
|
||||
CHECK_EQUAL(1, observer1.data2_count);
|
||||
CHECK_EQUAL(0, observer1.data3_count);
|
||||
|
||||
CHECK_EQUAL(0, observer2.data1_count);
|
||||
CHECK_EQUAL(0, observer2.data2_count);
|
||||
CHECK_EQUAL(0, observer2.data3_count);
|
||||
|
||||
observable2.send_notifications(); // Updates data3. observeable2 has no observers yet.
|
||||
|
||||
CHECK_EQUAL(1, observer1.data1_count);
|
||||
CHECK_EQUAL(1, observer1.data2_count);
|
||||
CHECK_EQUAL(0, observer1.data3_count);
|
||||
|
||||
CHECK_EQUAL(0, observer2.data1_count);
|
||||
CHECK_EQUAL(0, observer2.data2_count);
|
||||
CHECK_EQUAL(0, observer2.data3_count);
|
||||
|
||||
// Add an observer to both.
|
||||
observable1.add_observer(observer2);
|
||||
observable2.add_observer(observer2);
|
||||
|
||||
// Send the notifications.
|
||||
observable1.send_notifications(); // Updates data1 & data2.
|
||||
|
||||
CHECK_EQUAL(2, observer1.data1_count);
|
||||
CHECK_EQUAL(2, observer1.data2_count);
|
||||
CHECK_EQUAL(0, observer1.data3_count);
|
||||
|
||||
CHECK_EQUAL(1, observer2.data1_count);
|
||||
CHECK_EQUAL(1, observer2.data2_count);
|
||||
CHECK_EQUAL(0, observer2.data3_count);
|
||||
|
||||
observable2.send_notifications(); // Updates data3.
|
||||
|
||||
CHECK_EQUAL(2, observer1.data1_count);
|
||||
CHECK_EQUAL(2, observer1.data2_count);
|
||||
CHECK_EQUAL(0, observer1.data3_count);
|
||||
|
||||
CHECK_EQUAL(1, observer2.data1_count);
|
||||
CHECK_EQUAL(1, observer2.data2_count);
|
||||
CHECK_EQUAL(1, observer2.data3_count);
|
||||
|
||||
observable1.remove_observer(observer1);
|
||||
|
||||
// Send the notifications.
|
||||
observable1.send_notifications(); // Updates data1 & data2.
|
||||
|
||||
CHECK_EQUAL(2, observer1.data1_count);
|
||||
CHECK_EQUAL(2, observer1.data2_count);
|
||||
CHECK_EQUAL(0, observer1.data3_count);
|
||||
|
||||
CHECK_EQUAL(2, observer2.data1_count);
|
||||
CHECK_EQUAL(2, observer2.data2_count);
|
||||
CHECK_EQUAL(1, observer2.data3_count);
|
||||
|
||||
observable2.send_notifications(); // Updates data3.
|
||||
|
||||
CHECK_EQUAL(2, observer1.data1_count);
|
||||
CHECK_EQUAL(2, observer1.data2_count);
|
||||
CHECK_EQUAL(0, observer1.data3_count);
|
||||
|
||||
CHECK_EQUAL(2, observer2.data1_count);
|
||||
CHECK_EQUAL(2, observer2.data2_count);
|
||||
CHECK_EQUAL(2, observer2.data3_count);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_observable_2_observers_enable_disable)
|
||||
{
|
||||
// The observable objects.
|
||||
Observable1 observable1;
|
||||
|
||||
// The observer objects.
|
||||
Observer1 observer1;
|
||||
Observer2 observer2;
|
||||
|
||||
observable1.add_observer(observer1);
|
||||
observable1.add_observer(observer2);
|
||||
|
||||
// Send the notifications.
|
||||
observable1.send_notifications();
|
||||
|
||||
CHECK_EQUAL(1, observer1.data1_count);
|
||||
CHECK_EQUAL(1, observer2.data1_count);
|
||||
|
||||
// Disable observer1. Send the notifications.
|
||||
observable1.disable_observer(observer1);
|
||||
observable1.send_notifications();
|
||||
|
||||
CHECK_EQUAL(1, observer1.data1_count);
|
||||
CHECK_EQUAL(2, observer2.data1_count);
|
||||
|
||||
// Disable observer2. Send the notifications.
|
||||
observable1.enable_observer(observer2, false);
|
||||
observable1.send_notifications();
|
||||
|
||||
CHECK_EQUAL(1, observer1.data1_count);
|
||||
CHECK_EQUAL(2, observer2.data1_count);
|
||||
|
||||
// Enable observer1. Send the notifications.
|
||||
observable1.enable_observer(observer1);
|
||||
observable1.send_notifications();
|
||||
|
||||
CHECK_EQUAL(2, observer1.data1_count);
|
||||
CHECK_EQUAL(2, observer2.data1_count);
|
||||
|
||||
// Enable observer2. Send the notifications.
|
||||
observable1.enable_observer(observer2, true);
|
||||
observable1.send_notifications();
|
||||
|
||||
CHECK_EQUAL(3, observer1.data1_count);
|
||||
CHECK_EQUAL(3, observer2.data1_count);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_8_notifications)
|
||||
{
|
||||
typedef etl::observer<Notification<1>, Notification<2>, Notification<3>, Notification<4>, Notification<5>, Notification<6>, Notification<7>, Notification<8> > Observer;
|
||||
|
||||
class Observable : public etl::observable<Observer, 1>
|
||||
{
|
||||
};
|
||||
|
||||
// This test just needs to compile without errors.
|
||||
CHECK(true);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_7_notifications)
|
||||
{
|
||||
typedef etl::observer<Notification<1>, Notification<2>, Notification<3>, Notification<4>, Notification<5>, Notification<6>, Notification<7> > Observer;
|
||||
|
||||
class Observable : public etl::observable<Observer, 1>
|
||||
{
|
||||
};
|
||||
|
||||
// This test just needs to compile without errors.
|
||||
CHECK(true);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_6_notifications)
|
||||
{
|
||||
typedef etl::observer<Notification<1>, Notification<2>, Notification<3>, Notification<4>, Notification<5>, Notification<6> > Observer;
|
||||
|
||||
class Observable : public etl::observable<Observer, 1>
|
||||
{
|
||||
};
|
||||
|
||||
// This test just needs to compile without errors.
|
||||
CHECK(true);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_5_notifications)
|
||||
{
|
||||
typedef etl::observer<Notification<1>, Notification<2>, Notification<3>, Notification<4>, Notification<5> > Observer;
|
||||
|
||||
class Observable : public etl::observable<Observer, 1>
|
||||
{
|
||||
};
|
||||
|
||||
// This test just needs to compile without errors.
|
||||
CHECK(true);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_4_notifications)
|
||||
{
|
||||
typedef etl::observer<Notification<1>, Notification<2>, Notification<3>, Notification<4> > Observer;
|
||||
|
||||
class Observable : public etl::observable<Observer, 1>
|
||||
{
|
||||
};
|
||||
|
||||
// This test just needs to compile without errors.
|
||||
CHECK(true);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_3_notifications)
|
||||
{
|
||||
typedef etl::observer<Notification<1>, Notification<2>, Notification<3> > Observer;
|
||||
|
||||
class Observable : public etl::observable<Observer, 1>
|
||||
{
|
||||
};
|
||||
|
||||
// This test just needs to compile without errors.
|
||||
CHECK(true);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_2_notifications)
|
||||
{
|
||||
typedef etl::observer<Notification<1>, Notification<2> > Observer;
|
||||
|
||||
class Observable : public etl::observable<Observer, 1>
|
||||
{
|
||||
};
|
||||
|
||||
// This test just needs to compile without errors.
|
||||
CHECK(true);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_1_notification)
|
||||
{
|
||||
typedef etl::observer<Notification<1> > Observer;
|
||||
|
||||
class Observable : public etl::observable<Observer, 1>
|
||||
{
|
||||
};
|
||||
|
||||
// This test just needs to compile without errors.
|
||||
CHECK(true);
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_observer_list)
|
||||
{
|
||||
class Observer : public etl::observer<Notification1>
|
||||
{
|
||||
void notification(Notification1) {}
|
||||
};
|
||||
|
||||
class Observable : public etl::observable<Observer, 4>
|
||||
{
|
||||
};
|
||||
|
||||
Observable observable;
|
||||
|
||||
Observer observer1;
|
||||
Observer observer2;
|
||||
Observer observer3;
|
||||
Observer observer4;
|
||||
Observer observer5;
|
||||
|
||||
observable.add_observer(observer1);
|
||||
CHECK_EQUAL(1UL, observable.number_of_observers());
|
||||
|
||||
observable.add_observer(observer2);
|
||||
CHECK_EQUAL(2UL, observable.number_of_observers());
|
||||
|
||||
observable.add_observer(observer3);
|
||||
CHECK_EQUAL(3UL, observable.number_of_observers());
|
||||
|
||||
observable.add_observer(observer2);
|
||||
CHECK_EQUAL(3UL, observable.number_of_observers());
|
||||
|
||||
observable.add_observer(observer4);
|
||||
CHECK_EQUAL(4UL, observable.number_of_observers());
|
||||
|
||||
CHECK_THROW(observable.add_observer(observer5), etl::observer_list_full);
|
||||
|
||||
CHECK(observable.remove_observer(observer3));
|
||||
CHECK_EQUAL(3UL, observable.number_of_observers());
|
||||
|
||||
// Try again.
|
||||
CHECK(!observable.remove_observer(observer3));
|
||||
CHECK_EQUAL(3UL, observable.number_of_observers());
|
||||
|
||||
observable.clear_observers();
|
||||
CHECK_EQUAL(0UL, observable.number_of_observers());
|
||||
}
|
||||
|
||||
//*************************************************************************
|
||||
TEST(test_void_int_observable)
|
||||
{
|
||||
// The observable objects.
|
||||
ObservableVoidInt observable;
|
||||
|
||||
// The observer objects.
|
||||
ObserverVoidInt observer;
|
||||
|
||||
observable.add_observer(observer);
|
||||
|
||||
// Send the notifications.
|
||||
observable.send_notifications();
|
||||
CHECK_EQUAL(1U, observer.data1_count);
|
||||
CHECK_EQUAL(0U, observer.data2_count);
|
||||
|
||||
observable.send_notifications(1);
|
||||
CHECK_EQUAL(1U, observer.data1_count);
|
||||
CHECK_EQUAL(1U, observer.data2_count);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue