src/testutils/cmdlinetest.cpp

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