Skip to content

Commit

Permalink
Merge branch 'sshirokov/84_pmr_fun_ubvar_/valueless' into sshirokov/8…
Browse files Browse the repository at this point in the history 
…4_pmr_fun_ubvar_/valueless_fun #verification #docs #sonar
  • Loading branch information
@serges147
serges147 committed May 31, 2024
2 parents a9de16b + 4052fce commit 9204f62
Show file tree
Hide file tree
Showing 11 changed files with 337 additions and 292 deletions.
2 changes: 1 addition & 1 deletion cetlvast/suites/compile/test_unbounded_variant_footprint_get_const.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ int main()

#ifndef CETLVAST_COMPILETEST_PRECHECK

// Verify at `cetl::detail::base_storage::get_ptr const`
// Verify at `cetl::detail::base_storage::check_footprint` (called from `base_access::get_ptr() const`).
// ```
// static_assert(sizeof(ValueType) <= Footprint,
// "Cannot contain the requested type since the footprint is too small");
Expand Down
2 changes: 1 addition & 1 deletion cetlvast/suites/compile/test_unbounded_variant_footprint_get_non_const.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ int main()

#ifndef CETLVAST_COMPILETEST_PRECHECK

// Verify at `cetl::detail::base_storage::get_ptr`
// Verify at `cetl::detail::base_storage::check_footprint` (called from `base_access::get_ptr()`).
// ```
// static_assert(sizeof(ValueType) <= Footprint,
// "Cannot contain the requested type since the footprint is too small");
Expand Down
4 changes: 2 additions & 2 deletions cetlvast/suites/compile/test_unbounded_variant_footprint_set.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ int main()

#ifndef CETLVAST_COMPILETEST_PRECHECK

// Verify at `cetl::detail::base_storage::make_handlers`
// Verify at `cetl::detail::base_storage::check_footprint` (called from `base_access::make_handlers()`).
// ```
// static_assert(sizeof(Tp) <= Footprint || IsPmr, "Enlarge the footprint");
// static_assert(sizeof(Tp) <= Footprint, "Enlarge the footprint");
// ```
test = static_cast<uint16_t>(1);

Expand Down
27 changes: 27 additions & 0 deletions cetlvast/suites/compile/test_unbounded_variant_zero_footprint_non_pmr.cpp
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/// @file
/// Compile test that ensures it's impossible to use non-PMR `unbounded_variant` with zero footprint.
///
/// @copyright
/// Copyright (C) OpenCyphal Development Team <opencyphal.org>
/// Copyright Amazon.com Inc. or its affiliates.
/// SPDX-License-Identifier: MIT
///

#include "cetl/unbounded_variant.hpp"

#include <cstdint>

int main()
{
#ifndef CETLVAST_COMPILETEST_PRECHECK

cetl::unbounded_variant<0> test{};

#else

cetl::unbounded_variant<1> test{};

#endif

return 0;
}
2 changes: 1 addition & 1 deletion cetlvast/suites/docs/examples/example_07_polymorphic_alloc_deleter.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ class example_07_polymorphic_alloc_deleter : public testing::Test
{
protected:
template <typename Interface>
using InterfacePtr = cetl::pmr::InterfacePtr<Interface>;
using InterfacePtr = cetl::pmr::InterfacePtr<Interface, cetl::pmr::memory_resource>;

void SetUp() override
{
Expand Down
79 changes: 34 additions & 45 deletions cetlvast/suites/unittest/pmr/test_pmr_function.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,29 @@ using testing::IsEmpty;
class TestPmrFunction : public testing::Test
{
protected:
void SetUp() override {}
using pmr = cetl::pmr::memory_resource;

void TearDown() override
{
EXPECT_THAT(mr_.allocations, IsEmpty());
EXPECT_THAT(mr_.total_allocated_bytes, mr_.total_deallocated_bytes);

cetl::pmr::set_default_resource(nullptr);
}

static std::string print_num(int i)
{
return testing::PrintToString(i);
}

cetl::pmr::memory_resource* get_mr() noexcept
pmr* get_mr() noexcept
{
return &mr_;
}

pmr* get_default_mr() noexcept
{
return cetl::pmr::get_default_resource();
}

cetlvast::TrackingMemoryResource mr_;
};

Expand Down Expand Up @@ -121,14 +124,7 @@ TEST_F(TestPmrFunction, cpp_reference)

TEST_F(TestPmrFunction, ctor_1_default)
{
const function<void(), 0> f1{};
EXPECT_THAT(!f1, Not(false));
EXPECT_THAT(static_cast<bool>(f1), false);
}

TEST_F(TestPmrFunction, ctor_2_nullptr)
{
const function<void(), 0> f1{nullptr};
const function<void(), 1> f1{};
EXPECT_THAT(!f1, Not(false));
EXPECT_THAT(static_cast<bool>(f1), false);
}
Expand Down Expand Up @@ -220,8 +216,8 @@ TEST_F(TestPmrFunction, assign_4_rv_functor)
f2 = [f1](const std::string& rhs) { return f1(rhs) + "B"; };
EXPECT_THAT(f2("x"), "AxB");

// Note: we move assign different type of function (Footprint and IsPmr).
function<std::string(const std::string&), 0, true /*IsPmr*/> f0{[](const std::string&) { return "123"; }};
// Note: we move assign different type of function (Footprint and Pmr).
function<std::string(const std::string&), 0, pmr> f0{get_default_mr(), [](const std::string&) { return "123"; }};
f2 = std::move(f0);
EXPECT_THAT(!!f0, false);
EXPECT_THAT(f2("x"), "123");
Expand All @@ -239,11 +235,12 @@ TEST_F(TestPmrFunction, assign_4_lv_functor)
f2 = l2;
EXPECT_THAT(f2("x"), "AxB");

// Note: we copy assign different type of function (Footprint and IsPmr).
const function<std::string(const std::string&), 0, true /*IsPmr*/> f0{[](const std::string&) { return "123"; }};
// Note: we copy assign different type of function (Footprint and Pmr).
const function<std::string(const std::string&), 0, pmr> f0{get_default_mr(),
[](const std::string&) { return "123"; }};
f2 = f0;
EXPECT_THAT(!!f0, true);
EXPECT_THAT(f0.get_memory_resource(), cetl::pmr::get_default_resource());
EXPECT_THAT(f0.get_memory_resource(), get_default_mr());
EXPECT_THAT(f2("x"), "123");
}

Expand All @@ -265,23 +262,15 @@ TEST_F(TestPmrFunction, swap)

TEST_F(TestPmrFunction, pmr_ctor_1_default)
{
const function<void(), 0, true /*IsPmr*/> f1;
const function<void(), 0, pmr> f1{get_default_mr()};
EXPECT_THAT(!f1, Not(false));
EXPECT_THAT(static_cast<bool>(f1), false);
EXPECT_THAT(f1.get_memory_resource(), cetl::pmr::get_default_resource());
}

TEST_F(TestPmrFunction, pmr_ctor_2_nullptr)
{
const function<void(), 0, true /*IsPmr*/> f1{nullptr};
EXPECT_THAT(!f1, Not(false));
EXPECT_THAT(static_cast<bool>(f1), false);
EXPECT_THAT(f1.get_memory_resource(), cetl::pmr::get_default_resource());
EXPECT_THAT(f1.get_memory_resource(), get_default_mr());
}

TEST_F(TestPmrFunction, pmr_ctor_3_copy)
{
using str_function = function<std::string(), 24, true /*IsPmr*/>;
using str_function = function<std::string(), 24, pmr>;
const str_function fn{get_mr(), std::bind(print_num, 123)};

str_function fn_copy{fn};
Expand All @@ -297,7 +286,7 @@ TEST_F(TestPmrFunction, pmr_ctor_3_copy)

TEST_F(TestPmrFunction, pmr_ctor_4_move)
{
using str_function = function<std::string(), 24, true /*IsPmr*/>;
using str_function = function<std::string(), 24, pmr>;
str_function fn{get_mr(), []() { return print_num(123); }};

str_function fn_moved{std::move(fn)};
Expand All @@ -313,16 +302,16 @@ TEST_F(TestPmrFunction, pmr_ctor_4_move)

TEST_F(TestPmrFunction, pmr_ctor_5_lambda_default_mr_)
{
using str_function = function<std::string(), 24, true /*IsPmr*/>;
str_function fn{[]() { return print_num(123); }};
using str_function = function<std::string(), 24, pmr>;
str_function fn{get_default_mr(), []() { return print_num(123); }};
EXPECT_THAT(!!fn, true);
EXPECT_THAT(fn(), "123");
EXPECT_THAT(fn.get_memory_resource(), cetl::pmr::get_default_resource());
EXPECT_THAT(fn.get_memory_resource(), get_default_mr());
}

TEST_F(TestPmrFunction, pmr_ctor_5_lambda_custom_mr_)
{
using str_function = function<std::string(), 0, true /*IsPmr*/>;
using str_function = function<std::string(), 0, pmr>;
str_function fn{get_mr(), []() { return print_num(123); }};
EXPECT_THAT(!!fn, true);
EXPECT_THAT(fn(), "123");
Expand All @@ -331,14 +320,14 @@ TEST_F(TestPmrFunction, pmr_ctor_5_lambda_custom_mr_)

TEST_F(TestPmrFunction, pmr_ctor_memory_resource)
{
const function<void(), 0, true /*IsPmr*/> f1{get_mr()};
const function<void(), 0, pmr> f1{get_mr()};
EXPECT_THAT(!f1, Not(false));
EXPECT_THAT(static_cast<bool>(f1), false);
}

TEST_F(TestPmrFunction, pmr_assign_1_copy_fit)
{
using str_function = function<std::string(), 32, true /*IsPmr*/>;
using str_function = function<std::string(), 32, pmr>;

const str_function fn1{get_mr(), []() { return print_num(123); }};
EXPECT_THAT(!!fn1, true);
Expand All @@ -358,7 +347,7 @@ TEST_F(TestPmrFunction, pmr_assign_1_copy_fit)

TEST_F(TestPmrFunction, pmr_assign_1_copy_nofit)
{
using str_function = function<std::string(), 1, true /*IsPmr*/>;
using str_function = function<std::string(), 1, pmr>;

const str_function fn1{get_mr(), []() { return print_num(123); }};
EXPECT_THAT(!!fn1, true);
Expand All @@ -379,7 +368,7 @@ TEST_F(TestPmrFunction, pmr_assign_1_copy_nofit)

TEST_F(TestPmrFunction, pmr_assign_2_move_fit)
{
using str_function = function<std::string(), 32, true /*IsPmr*/>;
using str_function = function<std::string(), 32, pmr>;

str_function fn1{get_mr(), []() { return print_num(123); }};
EXPECT_THAT(!!fn1, true);
Expand All @@ -396,7 +385,7 @@ TEST_F(TestPmrFunction, pmr_assign_2_move_fit)

TEST_F(TestPmrFunction, pmr_assign_2_move_nofit)
{
using str_function = function<std::string(), 1, true /*IsPmr*/>;
using str_function = function<std::string(), 1, pmr>;

str_function fn1{get_mr(), []() { return print_num(123); }};
EXPECT_THAT(!!fn1, true);
Expand All @@ -413,7 +402,7 @@ TEST_F(TestPmrFunction, pmr_assign_2_move_nofit)

TEST_F(TestPmrFunction, pmr_assign_3_nullptr)
{
using str_function = function<std::string(), 24, true /*IsPmr*/>;
using str_function = function<std::string(), 24, pmr>;
str_function fn{get_mr(), []() { return print_num(123); }};
EXPECT_THAT(!!fn, true);

Expand All @@ -424,7 +413,7 @@ TEST_F(TestPmrFunction, pmr_assign_3_nullptr)

TEST_F(TestPmrFunction, pmr_assign_4_rv_functor)
{
using str_function = function<std::string(const std::string&), 24, true /*IsPmr*/>;
using str_function = function<std::string(const std::string&), 24, pmr>;

str_function f1{get_mr()};
f1 = [](const std::string& rhs) { return "A" + rhs; };
Expand All @@ -436,8 +425,8 @@ TEST_F(TestPmrFunction, pmr_assign_4_rv_functor)
EXPECT_THAT(f2("x"), "AxB");
EXPECT_THAT(f2.get_memory_resource(), get_mr());

// Note: we assign different type of function (different Footprint and IsPmr).
function<std::string(const std::string&), 16, false /*IsPmr*/> f0{[](const std::string&) { return "123"; }};
// Note: we assign different type of function (different Footprint and Pmr).
function<std::string(const std::string&), 16, void /*Pmr*/> f0{[](const std::string&) { return "123"; }};
f2 = std::move(f0);
EXPECT_THAT(!!f0, false);
EXPECT_THAT(f2("x"), "123");
Expand All @@ -446,7 +435,7 @@ TEST_F(TestPmrFunction, pmr_assign_4_rv_functor)

TEST_F(TestPmrFunction, pmr_assign_4_lv_functor)
{
using str_function = function<std::string(const std::string&), 24, true /*IsPmr*/>;
using str_function = function<std::string(const std::string&), 24, pmr>;

str_function f1{get_mr()};
auto l1 = [](const std::string& rhs) { return "A" + rhs; };
Expand All @@ -460,8 +449,8 @@ TEST_F(TestPmrFunction, pmr_assign_4_lv_functor)
EXPECT_THAT(f2("x"), "AxB");
EXPECT_THAT(f2.get_memory_resource(), get_mr());

// Note: we copy assign different type of function (Footprint and IsPmr).
const function<std::string(const std::string&), 16, false /*IsPmr*/> f0{[](const std::string&) { return "123"; }};
// Note: we copy assign different type of function (Footprint and Pmr).
const function<std::string(const std::string&), 16, void /*Pmr*/> f0{[](const std::string&) { return "123"; }};
f2 = f0;
EXPECT_THAT(!!f0, true);
EXPECT_THAT(f2("x"), "123");
Expand Down
8 changes: 5 additions & 3 deletions cetlvast/suites/unittest/pmr/test_pmr_interface_ptr.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,10 @@ class MyObject final : private MyObjectBase, public IIdentifiable, public IDescr
class TestPmrInterfacePtr : public testing::Test
{
protected:
using pmr = cetl::pmr::memory_resource;

template <typename Interface>
using InterfacePtr = cetl::pmr::InterfacePtr<Interface>;
using InterfacePtr = cetl::pmr::InterfacePtr<Interface, pmr>;

void SetUp() override
{
Expand All @@ -136,7 +138,7 @@ class TestPmrInterfacePtr : public testing::Test
EXPECT_THAT(mr_.total_allocated_bytes, mr_.total_deallocated_bytes);
}

cetl::pmr::memory_resource* get_mr() noexcept
pmr* get_mr() noexcept
{
return &mr_;
}
Expand Down Expand Up @@ -175,7 +177,7 @@ TEST_F(TestPmrInterfacePtr, up_cast_interface)
EXPECT_THAT(obj0->name(), "obj0");
EXPECT_THAT(obj0->describe(), "obj0 is a MyObject instance.");

cetl::pmr::InterfacePtr<INamed> obj0_named{std::move(obj0)};
cetl::pmr::InterfacePtr<INamed, cetl::pmr::memory_resource> obj0_named{std::move(obj0)};

EXPECT_THAT(obj0, IsNull());
EXPECT_THAT(obj0_named, NotNull());
Expand Down
Loading

0 comments on commit 9204f62

Please sign in to comment.