src/gromacs/utility/keyvaluetreemdpwriter.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,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 /*! \internal \file
  36  * \brief
  37  * Defines a function to write a flat key-value tree to look like
  38  * old-style mdp output.
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  * \ingroup module_utility
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "keyvaluetreemdpwriter.h"
  46
  47 #include <string>
  48
  49 #include "gromacs/utility/gmxassert.h"
  50 #include "gromacs/utility/keyvaluetree.h"
  51 #include "gromacs/utility/strconvert.h"
  52 #include "gromacs/utility/stringutil.h"
  53 #include "gromacs/utility/textwriter.h"
  54
  55 namespace gmx
  56 {
  57
  58 void writeKeyValueTreeAsMdp(TextWriter* writer, const KeyValueTreeObject& tree)
  59 {
  60     for (const auto& prop : tree.properties())
  61     {
  62         const auto& value = prop.value();
  63         GMX_RELEASE_ASSERT(!value.isObject(), "Only flat key-value trees can be written as mdp");
  64
  65         // Recognize a special key prefix that identifies comment
  66         // lines. This mechanism is not pretty, but our plan is to
  67         // write key-value trees, rather than old-style mdp, and
  68         // comments will need different handling then.
  69         if (prop.key().compare(0, 7, "comment") == 0)
  70         {
  71             GMX_RELEASE_ASSERT(prop.value().isType<std::string>(),
  72                                "Comments must have string-typed values");
  73             auto comment = prop.value().cast<std::string>();
  74             // TODO Consider implementing an MdpTextWriter that can
  75             // format an array of strings suitably, e.g. by prefixing
  76             // each line like "; %s". We'd need to implement arrays of
  77             // objects, such a comment key to be able to refer to an
  78             // array of strings. Also, we'd want to have a plan to
  79             // write such comments in whatever replaces the mdp
  80             // format.
  81             writer->writeLine(comment);
  82         }
  83         else
  84         {
  85             writer->writeString(formatString("%-24s = ", prop.key().c_str()));
  86             if (value.isArray())
  87             {
  88                 bool first = true;
  89                 for (const auto& elem : value.asArray().values())
  90                 {
  91                     GMX_RELEASE_ASSERT(!elem.isObject() && !elem.isArray(),
  92                                        "Arrays of objects not currently implemented");
  93                     if (!first)
  94                     {
  95                         writer->writeString(" ");
  96                     }
  97                     writer->writeString(simpleValueToString(elem));
  98                     first = false;
  99                 }
 100             }
 101             else
 102             {
 103                 writer->writeString(simpleValueToString(value));
 104             }
 105             writer->writeLine();
 106         }
 107     }
 108 }
 109
 110 } // namespace gmx