src/gromacs/utility/any.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::Any.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_ANY_H
  44 #define GMX_UTILITY_ANY_H
  45
  46 #include <memory>
  47 #include <string>
  48 #include <type_traits>
  49 #include <typeindex>
  50 #include <typeinfo>
  51 #include <utility>
  52
  53 #include "gromacs/compat/make_unique.h"
  54 #include "gromacs/utility/gmxassert.h"
  55
  56 namespace gmx
  57 {
  58
  59 /*! \libinternal \brief
  60  * Represents a dynamically typed value of an arbitrary type.
  61  *
  62  * To create a any, either initialize it as empty, or with the create()
  63  * method (or the equivalent constructor, if the type parameter can be deduced
  64  * and is clear to the reader from the context).
  65  *
  66  * To query the type of the contents in the any, use isEmpty(), type(), and
  67  * isType().
  68  *
  69  * To access the value, you need to know the type as a compile-time constant
  70  * (e.g., through branching based on isType()), and then use cast() or
  71  * tryCast().
  72  *
  73  * Methods in this class do not throw unless otherwise indicated.
  74  *
  75  * This provides essentially the same functionality as boost::any.
  76  *
  77  * \ingroup module_utility
  78  */
  79 class Any
  80 {
  81     public:
  82         /*! \brief
  83          * Creates a any that holds the given value.
  84          *
  85          * \throws std::bad_alloc if out of memory.
  86          *
  87          * This method allows explicitly specifying the template argument,
  88          * contrary to the templated constructor.
  89          */
  90         template <typename T>
  91         static Any create(const T &value) { return Any(value); }
  92         /*! \brief
  93          * Creates a any that holds the given value.
  94          *
  95          * \throws std::bad_alloc if out of memory.
  96          *
  97          * In addition to allowing specifying the template argument, this
  98          * method avoids copying when move-construction is possible.
  99          */
 100         template <typename T>
 101         static Any create(T &&value) { return Any(std::forward<T>(value)); }
 102
 103         //! Creates an empty any value.
 104         Any() {}
 105         /*! \brief
 106          * Creates a any that holds the given value.
 107          *
 108          * \throws std::bad_alloc if out of memory.
 109          */
 110         template <typename T, typename = typename std::enable_if<!std::is_same<T, Any>::value>::type>
 111         explicit Any(T &&value)
 112             : content_(new Content<typename std::decay<T>::type>(std::forward<T>(value)))
 113         {
 114         }
 115         /*! \brief
 116          * Creates a deep copy of a any.
 117          *
 118          * \throws std::bad_alloc if out of memory.
 119          */
 120         Any(const Any &other) : content_(other.cloneContent()) {}
 121         //! Move-constructs a any.
 122         Any(Any &&other) noexcept : content_(std::move(other.content_)) {}
 123         /*! \brief
 124          * Assigns the any.
 125          *
 126          * \throws std::bad_alloc if out of memory.
 127          */
 128         Any &operator=(const Any &other)
 129         {
 130             content_ = other.cloneContent();
 131             return *this;
 132         }
 133         //! Move-assigns the any.
 134         Any &operator=(Any &&other) noexcept
 135         {
 136             content_ = std::move(other.content_);
 137             return *this;
 138         }
 139
 140         //! Whether any value is stored.
 141         bool isEmpty() const { return content_ == nullptr; }
 142         //! Returns the dynamic type of the value that is currently stored.
 143         std::type_index type() const
 144         {
 145             const std::type_info &info
 146                 = !isEmpty() ? content_->typeInfo() : typeid(void);
 147             return std::type_index(info);
 148         }
 149         //! Returns whether the type stored matches the template parameter.
 150         template <typename T>
 151         bool isType() const
 152         {
 153             return !isEmpty() && content_->typeInfo() == typeid(T);
 154         }
 155
 156         /*! \brief
 157          * Tries to get the value as the given type.
 158          *
 159          * \tparam T  Type to get.
 160          * \returns Pointer to the value, or nullptr if the type does not match
 161          *     the stored value.
 162          */
 163         template <typename T>
 164         const T *tryCast() const
 165         {
 166             return isType<T>() ? &static_cast<Content<T> *>(content_.get())->value_ : nullptr;
 167         }
 168         /*! \brief
 169          * Gets the value when the type is known.
 170          *
 171          * \tparam T  Type to get (which must match what the any stores).
 172          *
 173          * Asserts if the any is empty or does not contain the requested type.
 174          */
 175         template <typename T>
 176         const T &cast() const
 177         {
 178             const T *value = tryCast<T>();
 179             GMX_RELEASE_ASSERT(value != nullptr, "Cast to incorrect type");
 180             return *value;
 181         }
 182         /*! \brief
 183          * Tries to get the value as the given type as a non-const pointer.
 184          *
 185          * \tparam T  Type to get.
 186          * \returns Pointer to the value, or nullptr if the type does not match
 187          *     the stored value.
 188          *
 189          * This method allows modifying the value in-place, which is useful
 190          * with more complicated data structures.
 191          */
 192         template <typename T>
 193         T *tryCastRef()
 194         {
 195             return isType<T>() ? &static_cast<Content<T> *>(content_.get())->value_ : nullptr;
 196         }
 197         /*! \brief
 198          * Gets the value when the type is known as a modifiable reference.
 199          *
 200          * \tparam T  Type to get (which must match what the any stores).
 201          *
 202          * Asserts if the any is empty or does not contain the requested type.
 203          */
 204         template <typename T>
 205         T &castRef()
 206         {
 207             T *value = tryCastRef<T>();
 208             GMX_RELEASE_ASSERT(value != nullptr, "Cast to incorrect type");
 209             return *value;
 210         }
 211
 212     private:
 213         class IContent
 214         {
 215             public:
 216                 virtual ~IContent() {}
 217                 virtual const std::type_info &typeInfo() const = 0;
 218                 virtual std::unique_ptr<IContent> clone() const = 0;
 219         };
 220
 221         template <typename T>
 222         class Content : public IContent
 223         {
 224             public:
 225                 explicit Content(const T &value) : value_(value) {}
 226                 explicit Content(T &&value) : value_(std::move(value)) {}
 227
 228                 const std::type_info &typeInfo() const override { return typeid(T); }
 229                 std::unique_ptr<IContent> clone() const override { return compat::make_unique<Content>(value_); }
 230
 231                 T value_;
 232         };
 233
 234         //! Creates a deep copy of the content.
 235         std::unique_ptr<IContent> cloneContent() const
 236         {
 237             return content_ != nullptr ? content_->clone() : nullptr;
 238         }
 239
 240         std::unique_ptr<IContent> content_;
 241 };
 242
 243 //! \cond libapi
 244 /*! \brief
 245  * Converts a Any value to a string.
 246  *
 247  * As the name suggests, only some types of "simple" values (such as int) are
 248  * supported.  Asserts for unsupported types.
 249  *
 250  * \ingroup module_utility
 251  */
 252 std::string simpleValueToString(const Any &value);
 253 //! \endcond
 254
 255 } // namespace gmx
 256
 257 #endif