src/testutils/cmdlinetest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013, 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  * Implements gmx::test::CommandLine.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "cmdlinetest.h"
  43
  44 #include <cstdlib>
  45 #include <cstring>
  46 #include <sstream>
  47
  48 #include <new>
  49 #include <vector>
  50
  51 #include "gromacs/utility/gmxassert.h"
  52 #include "gromacs/utility/programinfo.h"
  53
  54 namespace gmx
  55 {
  56 namespace test
  57 {
  58
  59 /********************************************************************
  60  * CommandLine::Impl
  61  */
  62
  63 class CommandLine::Impl
  64 {
  65     public:
  66         Impl(const char *const cmdline[], size_t count);
  67         ~Impl();
  68
  69         std::vector<char *>     args_;
  70         std::vector<char *>     argv_;
  71         int                     argc_;
  72 };
  73
  74 CommandLine::Impl::Impl(const char *const cmdline[], size_t count)
  75 {
  76     args_.reserve(count);
  77     argv_.reserve(count + 1);
  78     argc_ = static_cast<int>(count);
  79     for (size_t i = 0; i < count; ++i)
  80     {
  81         char *arg = strdup(cmdline[i]);
  82         if (arg == NULL)
  83         {
  84             throw std::bad_alloc();
  85         }
  86         args_.push_back(arg);
  87         argv_.push_back(arg);
  88     }
  89     argv_.push_back(NULL);
  90 }
  91
  92 CommandLine::Impl::~Impl()
  93 {
  94     for (size_t i = 0; i < args_.size(); ++i)
  95     {
  96         std::free(args_[i]);
  97     }
  98 }
  99
 100 /********************************************************************
 101  * CommandLine
 102  */
 103
 104 CommandLine::CommandLine()
 105     : impl_(new Impl(NULL, 0))
 106 {
 107 }
 108
 109 CommandLine::CommandLine(const char *const cmdline[], size_t count)
 110     : impl_(new Impl(cmdline, count))
 111 {
 112 }
 113
 114 CommandLine::CommandLine(const CommandLine &other)
 115     : impl_(new Impl(other.argv(), other.argc()))
 116 {
 117 }
 118
 119 CommandLine::~CommandLine()
 120 {
 121 }
 122
 123 void CommandLine::append(const char *arg)
 124 {
 125     GMX_RELEASE_ASSERT(impl_->argc_ == static_cast<int>(impl_->args_.size()),
 126                        "Command-line has been modified externally");
 127     size_t newSize = impl_->args_.size() + 1;
 128     impl_->args_.reserve(newSize);
 129     impl_->argv_.reserve(newSize + 1);
 130     char *newArg = strdup(arg);
 131     if (newArg == NULL)
 132     {
 133         throw std::bad_alloc();
 134     }
 135     impl_->args_.push_back(newArg);
 136     impl_->argv_.pop_back(); // Remove the trailing NULL.
 137     impl_->argv_.push_back(newArg);
 138     impl_->argv_.push_back(NULL);
 139     impl_->argc_ = static_cast<int>(newSize);
 140 }
 141
 142 namespace
 143 {
 144
 145 //! Helper function for converting values to strings
 146 template <typename T>
 147 std::string value2string(T value)
 148 {
 149     std::stringstream ss;
 150     ss << value;
 151     return ss.str();
 152 }
 153
 154 }
 155
 156 void CommandLine::addOption(const char *name,
 157                             const char *value)
 158 {
 159     append(name);
 160     append(value);
 161 }
 162
 163 void CommandLine::addOption(const char        *name,
 164                             const std::string &value)
 165 {
 166     addOption(name, value.c_str());
 167 }
 168
 169 void CommandLine::addOption(const char *name,
 170                             int         value)
 171 {
 172     append(name);
 173     append(value2string(value));
 174 }
 175
 176 void CommandLine::addOption(const char *name,
 177                             double      value)
 178 {
 179     append(name);
 180     append(value2string(value));
 181 }
 182
 183 int &CommandLine::argc()
 184 {
 185     return impl_->argc_;
 186 }
 187 char **CommandLine::argv()
 188 {
 189     return &impl_->argv_[0];
 190 }
 191 int CommandLine::argc() const
 192 {
 193     return impl_->argc_;
 194 }
 195 const char *const *CommandLine::argv() const
 196 {
 197     return &impl_->argv_[0];
 198 }
 199 const char *CommandLine::arg(int i) const
 200 {
 201     return impl_->argv_[i];
 202 }
 203
 204 std::string CommandLine::toString() const
 205 {
 206     return ProgramInfo(argc(), argv()).commandLine();
 207 }
 208
 209 } // namespace test
 210 } // namespace gmx