src/gromacs/commandline/filenm.h

   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 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \file
  39  * \brief
  40  * Declares t_filenm for old-style command-line parsing of file name options.
  41  *
  42  * \inpublicapi
  43  * \ingroup module_commandline
  44  */
  45 #ifndef GMX_COMMANDLINE_FILENM_H
  46 #define GMX_COMMANDLINE_FILENM_H
  47
  48 #include <string>
  49 #include <string_view>
  50 #include <vector>
  51
  52 #include "gromacs/fileio/filetypes.h"
  53
  54
  55 //! \addtogroup module_commandline
  56 //! \{
  57
  58 namespace gmx
  59 {
  60 template<typename>
  61 class ArrayRef;
  62 } // namespace gmx
  63
  64 /*! \brief
  65  * File name option definition for C code.
  66  *
  67  * \inpublicapi
  68  */
  69 struct t_filenm
  70 {
  71     int                      ftp; //!< File type, see enum in filetypes.h
  72     const char*              opt; //!< Command line option, can be nullptr in which case the commandline module, including all opt2??? functions below, will use the default option for the file type
  73     const char*              fn; //!< File name (as set in source code), can be nullptr in which case the commandline module will use the default file name for the file type
  74     unsigned long            flag;      //!< Flag for all kinds of info (see defs)
  75     std::vector<std::string> filenames; //!< File names
  76 };
  77
  78 //! Whether a file name option is set.
  79 #define ffSET 1 << 0
  80 //! Whether a file name option specifies an input file.
  81 #define ffREAD 1 << 1
  82 //! Whether a file name option specifies an output file.
  83 #define ffWRITE 1 << 2
  84 //! Whether a file name option specifies an optional file.
  85 #define ffOPT 1 << 3
  86 //! Whether a file name option specifies a library file.
  87 #define ffLIB 1 << 4
  88 //! Whether a file name option accepts multiple file names.
  89 #define ffMULT 1 << 5
  90 //! Whether an input file name option accepts non-existent files.
  91 #define ffALLOW_MISSING 1 << 6
  92 //! Convenience flag for an input/output file.
  93 #define ffRW (ffREAD | ffWRITE)
  94 //! Convenience flag for an optional input file.
  95 #define ffOPTRD (ffREAD | ffOPT)
  96 //! Convenience flag for an optional output file.
  97 #define ffOPTWR (ffWRITE | ffOPT)
  98 //! Convenience flag for an optional input/output file.
  99 #define ffOPTRW (ffRW | ffOPT)
 100 //! Convenience flag for a library input file.
 101 #define ffLIBRD (ffREAD | ffLIB)
 102 //! Convenience flag for an optional library input file.
 103 #define ffLIBOPTRD (ffOPTRD | ffLIB)
 104 //! Convenience flag for an input file that accepts multiple files.
 105 #define ffRDMULT (ffREAD | ffMULT)
 106 //! Convenience flag for an optional input file that accepts multiple files.
 107 #define ffOPTRDMULT (ffRDMULT | ffOPT)
 108 //! Convenience flag for an output file that accepts multiple files.
 109 #define ffWRMULT (ffWRITE | ffMULT)
 110 //! Convenience flag for an optional output file that accepts multiple files.
 111 #define ffOPTWRMULT (ffWRMULT | ffOPT)
 112
 113 /*! \brief
 114  * Returns the filename belonging to cmd-line option opt, or NULL when
 115  * no such option.
 116  */
 117 const char* opt2fn(const char* opt, int nfile, const t_filenm fnm[]);
 118
 119 /*! \brief
 120  * Returns the filenames belonging to cmd-line option opt.
 121  *
 122  * An assertion will fail when the option does not exist.
 123  */
 124 gmx::ArrayRef<const std::string> opt2fns(const char* opt, int nfile, const t_filenm fnm[]);
 125
 126 /*! \brief
 127  * Returns the filenames belonging to cmd-line option opt when set,
 128  * returns an empty vector when the option is not set.
 129  *
 130  * An assertion will fail when the option does not exist.
 131  */
 132 gmx::ArrayRef<const std::string> opt2fnsIfOptionSet(const char* opt, int nfile, const t_filenm fnm[]);
 133
 134 //! Returns a file pointer from the filename.
 135 #define opt2FILE(opt, nfile, fnm, mode) gmx_ffopen(opt2fn(opt, nfile, fnm), mode)
 136
 137 //! Returns the first file name with type ftp, or NULL when none found.
 138 const char* ftp2fn(int ftp, int nfile, const t_filenm fnm[]);
 139
 140 /*! \brief
 141  * Returns the filenames for the first option with type ftp.
 142  *
 143  * An assertion will fail when when none found.
 144  */
 145 gmx::ArrayRef<const std::string> ftp2fns(int ftp, int nfile, const t_filenm fnm[]);
 146
 147 //! Returns a file pointer from the file type.
 148 #define ftp2FILE(ftp, nfile, fnm, mode) gmx_ffopen(ftp2fn(ftp, nfile, fnm), mode)
 149
 150 //! Returns TRUE when this file type has been found on the cmd-line.
 151 bool ftp2bSet(int ftp, int nfile, const t_filenm fnm[]);
 152
 153 //! Returns TRUE when this option has been found on the cmd-line.
 154 bool opt2bSet(const char* opt, int nfile, const t_filenm fnm[]);
 155
 156 /*! \brief
 157  * Returns the file name belonging top cmd-line option opt, or NULL when
 158  * no such option.
 159  *
 160  * Also return NULL when opt is optional and option is not set.
 161  */
 162 const char* opt2fn_null(const char* opt, int nfile, const t_filenm fnm[]);
 163
 164 /*! \brief
 165  * Returns the first file name with type ftp, or NULL when none found.
 166  *
 167  * Also return NULL when ftp is optional and option is not set.
 168  */
 169 const char* ftp2fn_null(int ftp, int nfile, const t_filenm fnm[]);
 170
 171 //! Returns whether or not this filenm is optional.
 172 bool is_optional(const t_filenm* fnm);
 173
 174 //! Returns whether or not this filenm is output.
 175 bool is_output(const t_filenm* fnm);
 176
 177 //! Returns whether or not this filenm is set.
 178 bool is_set(const t_filenm* fnm);
 179
 180 /*! \brief Return whether \c filename might have been produced by mdrun -noappend.
 181  *
 182  * If so, it must match "prefix.partNNNN.extension", for four decimal
 183  * digits N and non-empty prefix and extension. */
 184 bool hasSuffixFromNoAppend(std::string_view filename);
 185
 186 /*! \brief
 187  * When we do checkpointing, this routine is called to check for previous
 188  * output files and append a '.partNNNN' suffix before the (output) file extensions.
 189  * If there was already a '.partNNNN' suffix before the file extension, that
 190  * is removed before the new suffix is added.
 191  */
 192 int add_suffix_to_output_names(t_filenm* fnm, int nfile, const char* suffix);
 193
 194 //! \}
 195
 196 #endif