src/gromacs/compat/tests/pointers.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief Tests for pointers.h, e.g. gmx::compat::not_null
  37  *
  38  * \author Mark Abraham <mark.j.abraham@gmail.com>
  39  * \ingroup module_compat
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/compat/pointers.h"
  44
  45 #include "config.h"
  46
  47 #include <memory>
  48 #include <vector>
  49
  50 #include <gtest/gtest.h>
  51
  52 #include "testutils/testasserts.h"
  53
  54 namespace gmx
  55 {
  56 namespace compat
  57 {
  58 namespace
  59 {
  60
  61 TEST(NotNullConstruction, Works)
  62 {
  63     // shared_ptr<int> is nullptr assignable
  64     not_null<std::shared_ptr<int>> sharedPointer(std::make_shared<int>(10));
  65
  66 #ifndef NDEBUG
  67 /* The workaround here is needed because the intel implementation
  68  * will not trigger the assert when using the pointer without
  69  * a valid object. This was needed due to an internal error
  70  * being triggered instead with the compiler under this condition.
  71  *
  72  * Death tests can also not be used safely in a parallel environment.
  73  */
  74 #    if !defined(__INTEL_COMPILER) || !(__INTEL_COMPILER == 1800 && __INTEL_COMPILER_UPDATE == 0)
  75     int* nullPointer = nullptr;
  76     GMX_EXPECT_DEATH_IF_SUPPORTED(not_null<int*> invalidNullPointer(nullPointer), "");
  77 #    endif
  78 #endif
  79
  80     int  value        = 20;
  81     int* validPointer = &value;
  82     {
  83         not_null<int*> validNotNullPointer(validPointer);
  84         GMX_UNUSED_VALUE(validNotNullPointer);
  85     }
  86     {
  87         not_null<int*> validNotNullPointer = not_null<int*>(validPointer);
  88         GMX_UNUSED_VALUE(validNotNullPointer);
  89     }
  90 }
  91
  92 TEST(NotNullCasting, Works)
  93 {
  94     struct MyBase
  95     {
  96     };
  97     struct MyDerived : public MyBase
  98     {
  99     };
 100     struct Unrelated
 101     {
 102     };
 103
 104     MyBase    base;
 105     MyDerived derived;
 106     Unrelated unrelated;
 107
 108     not_null<Unrelated*> u{ &unrelated };
 109     (void)u;
 110     not_null<MyDerived*> p{ &derived };
 111     not_null<MyBase*>    q(&base);
 112     // Allowed with heterogeneous copy constructor
 113     q = p;
 114
 115     not_null<Unrelated*> t(reinterpret_cast<Unrelated*>(p.get()));
 116     EXPECT_EQ(reinterpret_cast<void*>(p.get()), reinterpret_cast<void*>(t.get()));
 117 }
 118
 119 TEST(NotNullAssignment, Works)
 120 {
 121     int            i = 12;
 122     not_null<int*> p(&i);
 123     EXPECT_EQ(*p, 12);
 124 }
 125
 126 TEST(MakeNotNull, Works)
 127 {
 128     {
 129         int i = 42;
 130
 131         const not_null<int*> x = make_not_null(&i);
 132         EXPECT_EQ(*x, 42);
 133         not_null<int*> y = make_not_null(&i);
 134         EXPECT_EQ(*y, 42);
 135         not_null<const int*> z = make_not_null(&i);
 136         EXPECT_EQ(*z, 42);
 137     }
 138
 139     {
 140         // TODO These should work, but the GSL version of
 141         // make_not_null has an auto return type that we can't use
 142         // here, so maybe the issue is there.
 143         /*
 144            int i = 42;
 145            int* p = &i;
 146
 147            not_null<int *> x = make_not_null(p);
 148            EXPECT_EQ(*x, 42);
 149            not_null<int *> y = make_not_null(p);
 150            EXPECT_EQ(*y, 42);
 151            not_null<const int *> z = make_not_null(p);
 152            EXPECT_EQ(*z, 42);
 153          */
 154     }
 155
 156     {
 157         std::unique_ptr<int> i = std::make_unique<int>(42);
 158
 159         const not_null<int*> x = make_not_null(i);
 160         EXPECT_EQ(*x, 42);
 161         not_null<int*> y = make_not_null(i);
 162         EXPECT_EQ(*y, 42);
 163         not_null<const int*> z = make_not_null(i);
 164         EXPECT_EQ(*z, 42);
 165     }
 166
 167     {
 168         std::unique_ptr<const int> i = std::make_unique<int>(42);
 169
 170         // not_null<int *> does not compile, as expected
 171         not_null<const int*> z = make_not_null(i);
 172         EXPECT_EQ(*z, 42);
 173     }
 174 }
 175
 176 TEST(NotNull, WorksInContainers)
 177 {
 178     int            i = 12;
 179     not_null<int*> p(&i);
 180
 181     std::vector<not_null<int*>> v;
 182     v.push_back(p);
 183     EXPECT_EQ(*v.back(), 12);
 184 }
 185
 186 // TODO We currently don't have infrastructure for checking that e.g.
 187 // expected static assertions fire and calls to deleted functions do
 188 // not compile. When we do, there are more tests that should be found
 189 // here.
 190
 191 } // anonymous namespace
 192 } // namespace compat
 193 } // namespace gmx