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/smalloc.h"
  49 #include "gromacs/utility/stringutil.h"
  50
  51 /* Use bitflag ... */
  52 static bool IS_SET(const t_filenm &fileOption)
  53 {
  54     return (fileOption.flag & ffSET) != 0;
  55 }
  56
  57 static bool IS_OPT(const t_filenm &fileOption)
  58 {
  59     return (fileOption.flag & ffOPT) != 0;
  60 }
  61
  62 static const t_filenm *getFileOption(const char *opt, int nfile, const t_filenm fnm[])
  63 {
  64     GMX_RELEASE_ASSERT(nfile == 0 || fnm, "need a valid list of filenames");
  65
  66     for (int i = 0; i < nfile; i++)
  67     {
  68         if ((fnm[i].opt != nullptr && strcmp(opt, fnm[i].opt) == 0) ||
  69             (fnm[i].opt == nullptr && strcmp(opt, ftp2defopt(fnm[i].ftp)) == 0))
  70         {
  71             return &fnm[i];
  72         }
  73     }
  74
  75     return nullptr;
  76 }
  77
  78 const char *opt2fn(const char *opt, int nfile, const t_filenm fnm[])
  79 {
  80     const t_filenm *fileOption = getFileOption(opt, nfile, fnm);
  81
  82     if (fileOption)
  83     {
  84         return fileOption->filenames[0].c_str();
  85     }
  86
  87     GMX_RELEASE_ASSERT(false, "opt2fn should be called with a valid option");
  88
  89     return nullptr;
  90 }
  91
  92 gmx::ArrayRef<const std::string>
  93 opt2fns(const char *opt, int nfile, const t_filenm fnm[])
  94 {
  95     const t_filenm *fileOption = getFileOption(opt, nfile, fnm);
  96
  97     if (fileOption)
  98     {
  99         return fileOption->filenames;
 100     }
 101
 102     GMX_RELEASE_ASSERT(false, "opt2fns should be called with a valid option");
 103
 104     return gmx::EmptyArrayRef();
 105 }
 106
 107 gmx::ArrayRef<const std::string>
 108 opt2fnsIfOptionSet(const char *opt, int nfile, const t_filenm fnm[])
 109 {
 110     if (opt2bSet(opt, nfile, fnm))
 111     {
 112         return opt2fns(opt, nfile, fnm);
 113     }
 114     else
 115     {
 116         return gmx::EmptyArrayRef();
 117     }
 118 }
 119
 120 const char *ftp2fn(int ftp, int nfile, const t_filenm fnm[])
 121 {
 122     int i;
 123
 124     for (i = 0; (i < nfile); i++)
 125     {
 126         if (ftp == fnm[i].ftp)
 127         {
 128             return fnm[i].filenames[0].c_str();
 129         }
 130     }
 131
 132     GMX_RELEASE_ASSERT(false, "ftp2fn should be called with a valid option");
 133
 134     return nullptr;
 135 }
 136
 137 gmx::ArrayRef<const std::string>
 138 ftp2fns(int ftp, int nfile, const t_filenm fnm[])
 139 {
 140     for (int i = 0; (i < nfile); i++)
 141     {
 142         if (ftp == fnm[i].ftp)
 143         {
 144             return fnm[i].filenames;
 145         }
 146     }
 147
 148     GMX_RELEASE_ASSERT(false, "ftp2fns should be called with a valid option");
 149
 150     return gmx::EmptyArrayRef();
 151 }
 152
 153 gmx_bool ftp2bSet(int ftp, int nfile, const t_filenm fnm[])
 154 {
 155     int i;
 156
 157     for (i = 0; (i < nfile); i++)
 158     {
 159         if (ftp == fnm[i].ftp)
 160         {
 161             return static_cast<gmx_bool>(IS_SET(fnm[i]));
 162         }
 163     }
 164
 165     GMX_RELEASE_ASSERT(false, "ftp2bSet should be called with a valid option");
 166
 167     return FALSE;
 168 }
 169
 170 gmx_bool opt2bSet(const char *opt, int nfile, const t_filenm fnm[])
 171 {
 172     const t_filenm *fileOption = getFileOption(opt, nfile, fnm);
 173
 174     if (fileOption)
 175     {
 176         return static_cast<gmx_bool>(IS_SET(*fileOption));
 177     }
 178
 179     GMX_RELEASE_ASSERT(false, "opt2bSet should be called with a valid option");
 180
 181     return FALSE;
 182 }
 183
 184 const char *opt2fn_null(const char *opt, int nfile, const t_filenm fnm[])
 185 {
 186     const t_filenm *fileOption = getFileOption(opt, nfile, fnm);
 187
 188     if (fileOption)
 189     {
 190         if (IS_OPT(*fileOption) && !IS_SET(*fileOption))
 191         {
 192             return nullptr;
 193         }
 194         else
 195         {
 196             return fileOption->filenames[0].c_str();
 197         }
 198     }
 199
 200     GMX_RELEASE_ASSERT(false, "opt2fn_null should be called with a valid option");
 201
 202     return nullptr;
 203 }
 204
 205 const char *ftp2fn_null(int ftp, int nfile, const t_filenm fnm[])
 206 {
 207     int i;
 208
 209     for (i = 0; (i < nfile); i++)
 210     {
 211         if (ftp == fnm[i].ftp)
 212         {
 213             if (IS_OPT(fnm[i]) && !IS_SET(fnm[i]))
 214             {
 215                 return nullptr;
 216             }
 217             else
 218             {
 219                 return fnm[i].filenames[0].c_str();
 220             }
 221         }
 222     }
 223
 224     GMX_RELEASE_ASSERT(false, "ftp2fn_null should be called with a valid option");
 225
 226     return nullptr;
 227 }
 228
 229 gmx_bool is_optional(const t_filenm *fnm)
 230 {
 231     return ((fnm->flag & ffOPT) == ffOPT);
 232 }
 233
 234 gmx_bool is_output(const t_filenm *fnm)
 235 {
 236     return ((fnm->flag & ffWRITE) == ffWRITE);
 237 }
 238
 239 gmx_bool is_set(const t_filenm *fnm)
 240 {
 241     return ((fnm->flag & ffSET) == ffSET);
 242 }
 243
 244 int add_suffix_to_output_names(t_filenm *fnm, int nfile, const char *suffix)
 245 {
 246     char  buf[STRLEN];
 247     char *extpos;
 248
 249     for (int i = 0; i < nfile; i++)
 250     {
 251         if (is_output(&fnm[i]) && fnm[i].ftp != efCPT)
 252         {
 253             /* We never use multiple _outputs_, but we might as well check
 254                for it, just in case... */
 255             for (std::string &filename : fnm[i].filenames)
 256             {
 257                 std::strncpy(buf, filename.c_str(), STRLEN - 1);
 258                 extpos   = strrchr(buf, '.');
 259                 *extpos  = '\0';
 260                 filename = gmx::formatString("%s%s.%s", buf, suffix, extpos + 1);
 261             }
 262         }
 263     }
 264     return 0;
 265 }