src/gromacs/commandline/filenm.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017,2018, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #include "gmxpre.h"
  38
  39 #include "filenm.h"
  40
  41 #include <cstdio>
  42 #include <cstring>
  43
  44 #include "gromacs/fileio/filetypes.h"
  45 #include "gromacs/utility/basedefinitions.h"
  46 #include "gromacs/utility/cstringutil.h"
  47 #include "gromacs/utility/gmxassert.h"
  48 #include "gromacs/utility/path.h"
  49 #include "gromacs/utility/smalloc.h"
  50 #include "gromacs/utility/stringutil.h"
  51
  52 /* Use bitflag ... */
  53 static bool IS_SET(const t_filenm &fileOption)
  54 {
  55     return (fileOption.flag & ffSET) != 0;
  56 }
  57
  58 static bool IS_OPT(const t_filenm &fileOption)
  59 {
  60     return (fileOption.flag & ffOPT) != 0;
  61 }
  62
  63 static const t_filenm *getFileOption(const char *opt, int nfile, const t_filenm fnm[])
  64 {
  65     GMX_RELEASE_ASSERT(nfile == 0 || fnm, "need a valid list of filenames");
  66
  67     for (int i = 0; i < nfile; i++)
  68     {
  69         if ((fnm[i].opt != nullptr && strcmp(opt, fnm[i].opt) == 0) ||
  70             (fnm[i].opt == nullptr && strcmp(opt, ftp2defopt(fnm[i].ftp)) == 0))
  71         {
  72             return &fnm[i];
  73         }
  74     }
  75
  76     return nullptr;
  77 }
  78
  79 const char *opt2fn(const char *opt, int nfile, const t_filenm fnm[])
  80 {
  81     const t_filenm *fileOption = getFileOption(opt, nfile, fnm);
  82
  83     if (fileOption)
  84     {
  85         return fileOption->filenames[0].c_str();
  86     }
  87
  88     GMX_RELEASE_ASSERT(false, "opt2fn should be called with a valid option");
  89
  90     return nullptr;
  91 }
  92
  93 gmx::ArrayRef<const std::string>
  94 opt2fns(const char *opt, int nfile, const t_filenm fnm[])
  95 {
  96     const t_filenm *fileOption = getFileOption(opt, nfile, fnm);
  97
  98     if (fileOption)
  99     {
 100         return fileOption->filenames;
 101     }
 102
 103     GMX_RELEASE_ASSERT(false, "opt2fns should be called with a valid option");
 104
 105     return gmx::EmptyArrayRef();
 106 }
 107
 108 gmx::ArrayRef<const std::string>
 109 opt2fnsIfOptionSet(const char *opt, int nfile, const t_filenm fnm[])
 110 {
 111     if (opt2bSet(opt, nfile, fnm))
 112     {
 113         return opt2fns(opt, nfile, fnm);
 114     }
 115     else
 116     {
 117         return gmx::EmptyArrayRef();
 118     }
 119 }
 120
 121 const char *ftp2fn(int ftp, int nfile, const t_filenm fnm[])
 122 {
 123     int i;
 124
 125     for (i = 0; (i < nfile); i++)
 126     {
 127         if (ftp == fnm[i].ftp)
 128         {
 129             return fnm[i].filenames[0].c_str();
 130         }
 131     }
 132
 133     GMX_RELEASE_ASSERT(false, "ftp2fn should be called with a valid option");
 134
 135     return nullptr;
 136 }
 137
 138 gmx::ArrayRef<const std::string>
 139 ftp2fns(int ftp, int nfile, const t_filenm fnm[])
 140 {
 141     for (int i = 0; (i < nfile); i++)
 142     {
 143         if (ftp == fnm[i].ftp)
 144         {
 145             return fnm[i].filenames;
 146         }
 147     }
 148
 149     GMX_RELEASE_ASSERT(false, "ftp2fns should be called with a valid option");
 150
 151     return gmx::EmptyArrayRef();
 152 }
 153
 154 gmx_bool ftp2bSet(int ftp, int nfile, const t_filenm fnm[])
 155 {
 156     int i;
 157
 158     for (i = 0; (i < nfile); i++)
 159     {
 160         if (ftp == fnm[i].ftp)
 161         {
 162             return static_cast<gmx_bool>(IS_SET(fnm[i]));
 163         }
 164     }
 165
 166     GMX_RELEASE_ASSERT(false, "ftp2bSet should be called with a valid option");
 167
 168     return FALSE;
 169 }
 170
 171 gmx_bool opt2bSet(const char *opt, int nfile, const t_filenm fnm[])
 172 {
 173     const t_filenm *fileOption = getFileOption(opt, nfile, fnm);
 174
 175     if (fileOption)
 176     {
 177         return static_cast<gmx_bool>(IS_SET(*fileOption));
 178     }
 179
 180     GMX_RELEASE_ASSERT(false, "opt2bSet should be called with a valid option");
 181
 182     return FALSE;
 183 }
 184
 185 const char *opt2fn_null(const char *opt, int nfile, const t_filenm fnm[])
 186 {
 187     const t_filenm *fileOption = getFileOption(opt, nfile, fnm);
 188
 189     if (fileOption)
 190     {
 191         if (IS_OPT(*fileOption) && !IS_SET(*fileOption))
 192         {
 193             return nullptr;
 194         }
 195         else
 196         {
 197             return fileOption->filenames[0].c_str();
 198         }
 199     }
 200
 201     GMX_RELEASE_ASSERT(false, "opt2fn_null should be called with a valid option");
 202
 203     return nullptr;
 204 }
 205
 206 const char *ftp2fn_null(int ftp, int nfile, const t_filenm fnm[])
 207 {
 208     int i;
 209
 210     for (i = 0; (i < nfile); i++)
 211     {
 212         if (ftp == fnm[i].ftp)
 213         {
 214             if (IS_OPT(fnm[i]) && !IS_SET(fnm[i]))
 215             {
 216                 return nullptr;
 217             }
 218             else
 219             {
 220                 return fnm[i].filenames[0].c_str();
 221             }
 222         }
 223     }
 224
 225     GMX_RELEASE_ASSERT(false, "ftp2fn_null should be called with a valid option");
 226
 227     return nullptr;
 228 }
 229
 230 gmx_bool is_optional(const t_filenm *fnm)
 231 {
 232     return ((fnm->flag & ffOPT) == ffOPT);
 233 }
 234
 235 gmx_bool is_output(const t_filenm *fnm)
 236 {
 237     return ((fnm->flag & ffWRITE) == ffWRITE);
 238 }
 239
 240 gmx_bool is_set(const t_filenm *fnm)
 241 {
 242     return ((fnm->flag & ffSET) == ffSET);
 243 }
 244
 245 int add_suffix_to_output_names(t_filenm *fnm, int nfile, const char *suffix)
 246 {
 247     for (int i = 0; i < nfile; i++)
 248     {
 249         if (is_output(&fnm[i]) && fnm[i].ftp != efCPT)
 250         {
 251             /* We never use multiple _outputs_, but we might as well check
 252                for it, just in case... */
 253             for (std::string &filename : fnm[i].filenames)
 254             {
 255                 filename = gmx::Path::concatenateBeforeExtension(filename, suffix);
 256             }
 257         }
 258     }
 259     return 0;
 260 }