diff --git a/include/cont/edeque.h b/include/cont/edeque.h new file mode 100644 index 0000000..cdc03ad --- /dev/null +++ b/include/cont/edeque.h @@ -0,0 +1,265 @@ +/*! + * \file cont/edeque.h + * \brief + * A deque with event based callables + * + * \copyright Copyright (C) 2021 Christos Choutouridis + * + *
License
+ * The MIT License (MIT) + * + * 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. + *
+ */ + +#ifndef TBX_CONT_EDEQUE_H_ +#define TBX_CONT_EDEQUE_H_ + +#include +#include + +#include +#include +#include + +namespace tbx { + +/*! + * \class edeque + * \brief + * A statically allocated deque with size and data matching event based callables. + * + * The edeque inherits deque and provide the callable functionality as a wrapper. + * + * There are two types of events. + * - Size based events, which are cleared as soon as they served. These events are checked + * every time the deque change its size. If the criteria match we call the callable of type + * \c Fn + * - Data based events, which are permanently. These events are checked every time an item is + * pushed or popped from the deque. If the criteria match we call call the callable of type + * \c Fn + * + * \tparam Data_t The char-like queued item type. Usually \c char + * \tparam N The size of deque + * \tparam Fn The type of Callable + */ +template > +class edeque : public deque { + public: + // meta-identity types + using type = edeque; + using base_type = deque; + using callable_t = Fn; + + // STL + using value_type = typename base_type::value_type; + using reference = typename base_type::reference; + using const_reference = typename base_type::const_reference; + using pointer = typename base_type::pointer; + using const_pointer = typename base_type::const_pointer; + using iterator = typename base_type::iterator; + using const_iterator = typename base_type::const_iterator; + using reverse_iterator = typename base_type::reverse_iterator; + using const_reverse_iterator= typename base_type::const_reverse_iterator; + + //! \name Public types + //! @{ + public: + //! \enum match_mode + //! The mode of match operation + enum class match_mode { SIZE, DATA }; + //! \enum size_match + //! The type of matching for size based match + enum class size_match { DISABLED =0, EQ, NE, LT, LE, GT, GE }; + //! \enum data_match + //! The type of matching for data based match + enum class data_match { DISABLED =0, MATCH, MISMATCH}; + //! \struct size_trigger + //! Size trigger data type + struct size_trigger { + size_match type; + size_t size; + }; + //! \struct data_trigger + //! Data trigger data type + struct data_trigger { + data_match type; + Data_t value; + }; + //! \union trigger + //! \brief + //! A union for the common types. + //! There is only one mode. Either "size" with \ref size_match type and a size to match, + //! or "data" with \ref data_match type and a value to match + union trigger { + size_trigger tsize; + data_trigger tdata; + }; + //! @} + + //! \name Constructor / Destructor + //! @{ + public: + //! Default constructor + edeque () noexcept : + base_type() { } + + //! + edeque (size_match match, size_t size, callable_t&& fn) : + base_type(), + mode_{match_mode::SIZE}, + callback_{std::forward(fn)} { + trigger_.tsize.type = match; + trigger_.tsize.size = size; + } + + edeque (data_match match, Data_t value, callable_t&& fn) : + base_type(), + mode_{match_mode::DATA}, + callback_{std::forward(fn)} { + trigger_.tdata.type = match; + trigger_.tdata.value = value; + } + //! @} + + //! \name Public interface + //! @{ + + //! \brief + //! Manually checks the size trigger and calls it we have match. + //! \return True if the callable has called. + bool check_trigger () { + return check_trigger_size_(); + } + + //! \brief + //! Manually set (or alters) the \c size trigger. This function does not fire the + //! \ref check_trigger() + //! \param match The match type + //! \param size The size for with we check against + //! \param fn The callable to call on match + void set_trigger (size_match match, size_t size, callable_t&& fn) { + mode_ = match_mode::SIZE; + trigger_.tsize.type = match; + trigger_.tsize.size = size; + callback_ = std::forward(fn); + } + + //! \brief + //! Manually set (or alters) the \c data trigger. This function does not fire the + //! \ref check_trigger() + //! \param match The match type + //! \param value The value for with we check against + //! \param fn The callable to call on match + void set_trigger (data_match match, Data_t value, callable_t&& fn) { + mode_ = match_mode::DATA; + trigger_.tdata.type = match; + trigger_.tdata.value= value; + callback_ = std::forward(fn); + } + + //! \brief Manually clears the trigger + void clear_trigger () { + mode_ = match_mode{}; + trigger_ = trigger{}; + callback_ = callable_t{}; + } + //! @} + + //! \name Base class overwrites + //! @{ + void push_front (const Data_t& it) { + base_type::push_front(it); + check_trigger_async_(it); + } + Data_t pop_front () { + Data_t t = base_type::pop_front(); + check_trigger_async_(t); + return t; + } + void push_back (const Data_t& it) { + base_type::push_back(it); + check_trigger_async_(it); + } + Data_t pop_back () { + Data_t t = base_type::pop_back(); + check_trigger_async_(t); + return t; + } + //! @} + + //! \name Public interface + //! @{ + private: + //! \brief + //! Manually checks the size trigger and calls it we have match. + //! \return True if the callable has called. + bool check_trigger_size_ () { + bool match; + switch (trigger_.tsize.type) { + default: + case size_match::DISABLED: match = false; break; + case size_match::EQ: match = (base_type::size() == trigger_.tsize.size); break; + case size_match::NE: match = (base_type::size() != trigger_.tsize.size); break; + case size_match::LT: match = (base_type::size() < trigger_.tsize.size); break; + case size_match::LE: match = (base_type::size() <= trigger_.tsize.size); break; + case size_match::GT: match = (base_type::size() > trigger_.tsize.size); break; + case size_match::GE: match = (base_type::size() >= trigger_.tsize.size); break; + } + if (match) { + callback_(); + clear_trigger(); + } + return match; + } + + //! \brief + //! Manually checks the data trigger and calls it we have match. + //! \param it The item to check against + //! \return True if the callable has called. + bool check_trigger_value_ (const Data_t& it) { + bool match; + switch (trigger_.tdata.type) { + default: + case data_match::DISABLED: match = false; break; + case data_match::MATCH: match = (it == trigger_.tdata.value); break; + case data_match::MISMATCH: match = (it != trigger_.tdata.value); break; + } + if (match) + callback_(); + return match; + } + + //! Wrapper for both triggers + bool check_trigger_async_ (const Data_t& it) { + switch (mode_) { + default: + case match_mode::SIZE: return check_trigger_size_(); + case match_mode::DATA: return check_trigger_value_(it); + } + } + //! @} + private: + match_mode mode_{}; + trigger trigger_{}; + callable_t callback_{}; +}; +} + +#endif /* TBX_CONT_EDEQUE_H_ */ diff --git a/test/tests/edeque.cpp b/test/tests/edeque.cpp new file mode 100644 index 0000000..aea7246 --- /dev/null +++ b/test/tests/edeque.cpp @@ -0,0 +1,261 @@ +/*! + * \file deque.cpp + * \brief + * Unit tests for deque + * + * \copyright Copyright (C) 2020 Christos Choutouridis + * + *
License
+ * The MIT License (MIT) + * + * 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 +#include + +#include + +namespace Tdeque { + using namespace tbx; + + int global_flag =0; + + // Callable mocks + void vfun(void) { ++global_flag; } + + struct vfoo { + void operator() (void) { ++global_flag; } + }; + + + TEST (Tedeque, construct) { + using Edeque = edeque; + struct T { int a,b; }; + int local{}; + + Edeque e1(Edeque::size_match::GE, 3, [](){ + ++global_flag; + }); + Edeque e2(Edeque::size_match::GE, 3, [&](){ + ++local; + }); + Edeque e3(Edeque::size_match::EQ, 7, vfun); + edeque e4(edeque::size_match::EQ, 2, vfoo{}); + + EXPECT_EQ (8UL, e1.capacity()); + EXPECT_EQ (8UL, e2.capacity()); + EXPECT_EQ (8UL, e3.capacity()); + EXPECT_EQ (8UL, e4.capacity()); + } + + TEST (Tedeque, base_class) { + using Edeque = edeque; + + Edeque e1(Edeque::size_match::GE, 3, [](){ + ++global_flag; + }); + + // Access of base class functionality + EXPECT_EQ (8UL, e1.capacity()); + EXPECT_EQ (0UL, e1.size()); + EXPECT_EQ (true, e1.empty()); + EXPECT_EQ (false, e1.full()); + + e1.push_back(7); + EXPECT_EQ (7, e1.front()); + EXPECT_EQ (7, e1.back()); + EXPECT_EQ (7, e1.pop_front()); + + e1.push_front(42); + EXPECT_EQ (42, e1.front()); + EXPECT_EQ (42, e1.back()); + EXPECT_EQ (42, e1.pop_back()); + + e1.push_back(1); + e1.push_back(2); + e1.push_back(3); + + int check_it=1; + for (auto it = e1.begin() ; it != e1.end() ; ++it) + EXPECT_EQ(*it, check_it++); + EXPECT_EQ(4, check_it); // run through all + } + + TEST (Tedeque, set_clear_check_trigger) { + using Edeque = edeque; + bool flag{}; + + Edeque e1(Edeque::size_match::GE, 1, [&](){ flag = true; }); + + flag = false; + e1.clear_trigger(); + EXPECT_EQ (false, flag); + e1.push_back(1); // 1, no-trigger cleared + EXPECT_EQ (false, flag); + + flag = false; + e1.clear(); + e1.clear_trigger(); + EXPECT_EQ (false, flag); // no spurious triggers + e1.push_back(1); // 1 + e1.push_back(2); // 2 + e1.set_trigger(Edeque::size_match::GE, 1, [&](){ flag = true; }); + EXPECT_EQ (false, flag); // no spurious triggers + e1.check_trigger(); // manual trigger + EXPECT_EQ (true, flag); + + flag = false; + e1.check_trigger(); // manual trigger attempt + EXPECT_EQ (false, flag); // [SIZE triggers are auto clear] + + Edeque e2(Edeque::data_match::MATCH, 42, [&](){ flag = true; }); + flag = false; + e2.clear_trigger(); + EXPECT_EQ (false, flag); + e2.push_back(42); // push 42, no-trigger cleared + EXPECT_EQ (false, flag); + e2.set_trigger(Edeque::data_match::MATCH, 42, [&](){ flag = true; }); + EXPECT_EQ (false, flag); // no spurious triggers + e2.pop_back(); // pop 42, trigger + EXPECT_EQ (true, flag); + + flag = false; + e2.push_back(42); // push 42, re-trigger [DATA re-triggers] + EXPECT_EQ (true, flag); + } + + TEST (Tedeque, size_triggers) { + using Edeque = edeque; + bool flag{}; + + // size_match::GE (size()>= 2) + Edeque ee(Edeque::size_match::GE, 2, [&](){ flag = true; }); + + flag = false; + ee.clear(); + ee.push_back(1); // 1 + EXPECT_EQ (false, flag); + ee.push_back(2); // 2, trigger + EXPECT_EQ (true, flag); + flag = false; + ee.push_back(3); // 3, no-trigger cleared + EXPECT_EQ (false, flag); + + // size_match::GT (size()> 1) + flag = false; + ee.clear(); + ee.set_trigger(Edeque::size_match::GT, 1, [&](){ flag = true; }); + ee.push_back(1); // 1 + EXPECT_EQ (false, flag); + ee.push_back(2); // 2, trigger + EXPECT_EQ (true, flag); + flag = false; + ee.push_back(3); // 3, no-trigger cleared + EXPECT_EQ (false, flag); + + // size_match::LE (size()<= 1) + flag = false; + ee.clear(); + ee.push_back(1); // 1 + ee.push_back(2); // 2 + ee.push_back(3); // 3 + ee.set_trigger(Edeque::size_match::LE, 1, [&](){ flag = true; }); + ee.pop_front(); // 2 + EXPECT_EQ (false, flag); + ee.pop_front(); // 1, trigger + EXPECT_EQ (true, flag); + flag = false; + ee.pop_front(); // 0, no-trigger cleared + EXPECT_EQ (false, flag); + + // size_match::LT (size()< 2) + flag = false; + ee.clear(); + ee.push_back(1); // 1 + ee.push_back(2); // 2 + ee.push_back(3); // 3 + ee.set_trigger(Edeque::size_match::LT, 2, [&](){ flag = true; }); + ee.pop_front(); // 2 + EXPECT_EQ (false, flag); + ee.pop_front(); // 1, trigger + EXPECT_EQ (true, flag); + flag = false; + ee.pop_front(); // 0, no-trigger cleared + EXPECT_EQ (false, flag); + + // size_match::EQ (size()== 2) + flag = false; + ee.clear(); + ee.set_trigger(Edeque::size_match::EQ, 2, [&](){ flag = true; }); + ee.push_back(1); // 1 + EXPECT_EQ (false, flag); + ee.push_back(2); // 2, trigger + EXPECT_EQ (true, flag); + flag = false; + ee.push_back(3); // 3 + ee.pop_front(); // 2, no-trigger cleared + EXPECT_EQ (false, flag); + + // size_match::NE (size()!= 0) + flag = false; + ee.clear(); + ee.set_trigger(Edeque::size_match::NE, 0, [&](){ flag = true; }); + EXPECT_EQ (false, flag); + ee.push_back(1); // 1, trigger + EXPECT_EQ (true, flag); + flag = false; + ee.push_back(2); // 2, no-trigger + EXPECT_EQ (false, flag); + } + + TEST (Tedeque, data_triggers) { + using Edeque = edeque; + bool flag{}; + + // data_match::MATCH (item == 42) + Edeque ee(Edeque::data_match::MATCH, 42, [&](){ flag = true; }); + + flag = false; + ee.push_back(7); // 7 + EXPECT_EQ (false, flag); + ee.push_back(42); // push:42, trigger + EXPECT_EQ (true, flag); + + flag = false; + ee.pop_back(); // pop:42, trigger + EXPECT_EQ (true, flag); + + // data_match::MATCH (item != 42) + flag = false; + ee.clear(); + ee.push_back(7); // 7 + ee.set_trigger(Edeque::data_match::MISMATCH, 42, [&](){ flag = true; }); + EXPECT_EQ (false, flag); // no spurious triggers + ee.push_back(42); // 42, no-trigger + EXPECT_EQ (false, flag); + ee.push_back(0); // 0, trigger + EXPECT_EQ (true, flag); + + flag = false; + ee.push_back(1); // 1, re-trigger + EXPECT_EQ (true, flag); + } +}