2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2015,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.
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.
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.
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.
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.
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.
37 * Declares internal data structures for the reference data framework.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_testutils
42 #ifndef GMX_TESTUTILS_REFDATA_IMPL_H
43 #define GMX_TESTUTILS_REFDATA_IMPL_H
49 #include "gromacs/utility/gmxassert.h"
56 class ReferenceDataEntry
59 typedef std::unique_ptr<ReferenceDataEntry> EntryPointer;
60 typedef std::list<EntryPointer> ChildList;
61 typedef ChildList::const_iterator ChildIterator;
63 static EntryPointer createRoot() { return std::make_unique<ReferenceDataEntry>("", ""); }
65 ReferenceDataEntry(const char* type, const char* id) :
67 id_(id != nullptr ? id : ""),
69 hasBeenChecked_(false),
70 correspondingOutputEntry_(nullptr)
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 { return correspondingOutputEntry_; }
82 bool idMatches(const char* id) const
84 return (id == nullptr && id_.empty()) || (id != nullptr && id_ == id);
87 ChildIterator findChild(const char* id, const ChildIterator& prev) const
89 if (children_.empty())
91 return children_.end();
93 ChildIterator child = prev;
94 bool wrappingSearch = true;
95 if (child != children_.end())
97 if (id == nullptr && (*child)->id().empty())
99 wrappingSearch = false;
101 if (child == children_.end())
103 return children_.end();
109 child = children_.begin();
110 wrappingSearch = false;
114 if ((*child)->idMatches(id))
119 if (wrappingSearch && child == children_.end())
121 child = children_.begin();
123 } while (child != children_.end() && child != prev);
124 return children_.end();
126 bool isValidChild(const ChildIterator& prev) const { return prev != children_.end(); }
128 bool hasBeenChecked() const { return hasBeenChecked_; }
129 void setChecked() { hasBeenChecked_ = true; }
131 void setCheckedIncludingChildren()
134 for (const auto& child : children_)
136 child->setCheckedIncludingChildren();
140 EntryPointer cloneToOutputEntry()
142 EntryPointer entry(new ReferenceDataEntry(type_.c_str(), id_.c_str()));
143 setCorrespondingOutputEntry(entry.get());
144 entry->setValue(value());
145 entry->isTextBlock_ = isTextBlock_;
149 void setValue(const std::string& value)
151 GMX_RELEASE_ASSERT(!isCompound(), "Cannot have a value for a compound entry");
154 void setTextBlockValue(const std::string& value)
156 GMX_RELEASE_ASSERT(!isCompound(), "Cannot have a value for a compound entry");
160 void makeCompound(const char* type)
164 isTextBlock_ = false;
166 void setCorrespondingOutputEntry(ReferenceDataEntry* entry)
168 GMX_RELEASE_ASSERT(correspondingOutputEntry_ == nullptr, "Output entry already exists");
169 correspondingOutputEntry_ = entry;
171 ChildIterator addChild(EntryPointer child)
173 GMX_RELEASE_ASSERT(isCompound() || value_.empty(),
174 "Cannot make an entry with a value to a compound");
175 return children_.insert(children_.end(), move(child));
184 bool hasBeenChecked_;
185 ReferenceDataEntry* correspondingOutputEntry_;