src/testutils/refdata-impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2017, 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
  37  * Declares internal data structures for the reference data framework.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #ifndef GMX_TESTUTILS_REFDATA_IMPL_H
  43 #define GMX_TESTUTILS_REFDATA_IMPL_H
  44
  45 #include <list>
  46 #include <memory>
  47 #include <string>
  48
  49 #include "gromacs/utility/gmxassert.h"
  50
  51 namespace gmx
  52 {
  53 namespace test
  54 {
  55
  56 class ReferenceDataEntry
  57 {
  58     public:
  59         typedef std::unique_ptr<ReferenceDataEntry> EntryPointer;
  60         typedef std::list<EntryPointer> ChildList;
  61         typedef ChildList::const_iterator ChildIterator;
  62
  63         static EntryPointer createRoot()
  64         {
  65             return EntryPointer(new ReferenceDataEntry("", ""));
  66         }
  67
  68         ReferenceDataEntry(const char *type, const char *id)
  69             : type_(type), id_(id != nullptr ? id : ""), isTextBlock_(false),
  70               hasBeenChecked_(false), correspondingOutputEntry_(nullptr)
  71         {
  72         }
  73
  74         const std::string &type() const { return type_; }
  75         const std::string &id() const { return id_; }
  76         bool isCompound() const { return !children_.empty(); }
  77         bool isTextBlock() const { return isTextBlock_; }
  78         const std::string &value() const { return value_; }
  79         const ChildList &children() const { return children_; }
  80         ReferenceDataEntry *correspondingOutputEntry() const
  81         {
  82             return correspondingOutputEntry_;
  83         }
  84
  85         bool idMatches(const char *id) const
  86         {
  87             return (id == nullptr && id_.empty()) || (id != nullptr && id_ == id);
  88         }
  89
  90         ChildIterator findChild(const char *id, const ChildIterator &prev) const
  91         {
  92             if (children_.empty())
  93             {
  94                 return children_.end();
  95             }
  96             ChildIterator  child          = prev;
  97             bool           wrappingSearch = true;
  98             if (child != children_.end())
  99             {
 100                 if (id == nullptr && (*child)->id().empty())
 101                 {
 102                     wrappingSearch = false;
 103                     ++child;
 104                     if (child == children_.end())
 105                     {
 106                         return children_.end();
 107                     }
 108                 }
 109             }
 110             else
 111             {
 112                 child          = children_.begin();
 113                 wrappingSearch = false;
 114             }
 115             do
 116             {
 117                 if ((*child)->idMatches(id))
 118                 {
 119                     return child;
 120                 }
 121                 ++child;
 122                 if (wrappingSearch && child == children_.end())
 123                 {
 124                     child = children_.begin();
 125                 }
 126             }
 127             while (child != children_.end() && child != prev);
 128             return children_.end();
 129         }
 130         bool isValidChild(const ChildIterator &prev) const
 131         {
 132             return prev != children_.end();
 133         }
 134
 135         bool hasBeenChecked() const { return hasBeenChecked_; }
 136         void setChecked() { hasBeenChecked_ = true; }
 137
 138         void setCheckedIncludingChildren()
 139         {
 140             setChecked();
 141             for (const auto &child : children_)
 142             {
 143                 child->setCheckedIncludingChildren();
 144             }
 145         }
 146
 147         EntryPointer cloneToOutputEntry()
 148         {
 149             EntryPointer entry(new ReferenceDataEntry(type_.c_str(), id_.c_str()));
 150             setCorrespondingOutputEntry(entry.get());
 151             entry->setValue(value());
 152             entry->isTextBlock_ = isTextBlock_;
 153             return entry;
 154         }
 155
 156         void setValue(const std::string &value)
 157         {
 158             GMX_RELEASE_ASSERT(!isCompound(),
 159                                "Cannot have a value for a compound entry");
 160             value_ = value;
 161         }
 162         void setTextBlockValue(const std::string &value)
 163         {
 164             GMX_RELEASE_ASSERT(!isCompound(),
 165                                "Cannot have a value for a compound entry");
 166             value_       = value;
 167             isTextBlock_ = true;
 168         }
 169         void makeCompound(const char *type)
 170         {
 171             type_.assign(type);
 172             value_.clear();
 173             isTextBlock_ = false;
 174         }
 175         void setCorrespondingOutputEntry(ReferenceDataEntry *entry)
 176         {
 177             GMX_RELEASE_ASSERT(correspondingOutputEntry_ == nullptr,
 178                                "Output entry already exists");
 179             correspondingOutputEntry_ = entry;
 180         }
 181         ChildIterator addChild(EntryPointer child)
 182         {
 183             GMX_RELEASE_ASSERT(isCompound() || value_.empty(),
 184                                "Cannot make an entry with a value to a compound");
 185             return children_.insert(children_.end(), move(child));
 186         }
 187
 188     private:
 189         std::string         type_;
 190         std::string         id_;
 191         std::string         value_;
 192         bool                isTextBlock_;
 193         ChildList           children_;
 194         bool                hasBeenChecked_;
 195         ReferenceDataEntry *correspondingOutputEntry_;
 196 };
 197
 198 } // namespace test
 199 } // namespace gmx
 200
 201 #endif