2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014, 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.
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.
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.
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.
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.
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.
39 * Declares \c t_pargs, parse_common_args() and related methods.
42 * \ingroup module_commandline
44 #ifndef GMX_COMMANDLINE_PARGS_H
45 #define GMX_COMMANDLINE_PARGS_H
47 #include "../legacyheaders/types/simple.h"
48 #include "../legacyheaders/oenv.h"
49 #include "../fileio/filenm.h"
56 /*! \addtogroup module_commandline
60 /** Command line argument type. */
63 etINT, etINT64, etREAL, etTIME, etSTR, etBOOL, etRVEC, etENUM, etNR
67 * Command-line argument definition for C code.
73 /** Name of the argument (with leading dash included). */
75 /** Whether the argument is set (should be initialized to `FALSE`). */
77 /** Type of the argument (one of the enums in pargs.h). */
80 * Pointer to variable that is to receive the value.
82 * The expected type depends on the value of \a type.
83 * If an argument is not set by the user, then the pointed value is not
84 * changed. In other words, the initial value for the variable defines the
90 * Generic pointer for operations that do not need type information.
92 * Needs to be the first member to use initialized arrays.
95 /** Integer value for etINT. */
97 /** Integer value for etINT64. */
99 /** Real value for etREAL and etTIME. */
102 * String value for etSTR and etENUM.
104 * For etSTR, this should point to a `const char *` variable, which
105 * will receive a pointer to the string value (caller should not free
108 * For etENUM, this should be an array of `const char *` values, where
109 * the first and last values are `NULL`, and the other values define
110 * the allowed enum values. The first non-NULL value is the default
111 * value. After the arguments are parsed, the first element in the array
112 * points to the selected enum value (pointers will be equal).
115 /** Boolean value for etBOOL. */
117 /** Vector value for etRVEC. */
121 * Description for the argument.
123 * If the string starts with `HIDDEN`, then the argument is hidden from
124 * normal help listing and shell completions.
130 * Returns ordinal number for an etENUM argument.
132 * \param[in] enumc Array passed to `t_pargs` for an etENUM argument.
133 * \returns Index of selected enum value in the array.
135 * See t_pargs::u::c for the expected format of the array, including how the
136 * first element should be initialized.
137 * Note that the return value starts at one instead of zero: if the first enum
138 * value is selected, this returns 1.
140 int nenum(const char *const enumc[]);
143 * Returns value of an etINT option.
145 * \param[in] option Name of etINT argument to query.
146 * \param[in] nparg Number of elements in \p pa.
147 * \param[in] pa Array of arguments.
148 * \returns Value of \p option.
150 * \p option must specify a valid argument in \p pa of the correct type.
152 int opt2parg_int(const char *option, int nparg, t_pargs pa[]);
155 * Returns value of an etBOOL option.
157 * \param[in] option Name of etBOOL argument to query.
158 * \param[in] nparg Number of elements in \p pa.
159 * \param[in] pa Array of arguments.
160 * \returns Value of \p option.
162 * \p option must specify a valid argument in \p pa of the correct type.
164 gmx_bool opt2parg_bool(const char *option, int nparg, t_pargs pa[]);
167 * Returns value of an etREAL/etTIME option.
169 * \param[in] option Name of etREAL/etTIME argument to query.
170 * \param[in] nparg Number of elements in \p pa.
171 * \param[in] pa Array of arguments.
172 * \returns Value of \p option.
174 * \p option must specify a valid argument in \p pa of the correct type.
176 real opt2parg_real(const char *option, int nparg, t_pargs pa[]);
179 * Returns value of an etSTR option.
181 * \param[in] option Name of etSTR argument to query.
182 * \param[in] nparg Number of elements in \p pa.
183 * \param[in] pa Array of arguments.
184 * \returns Value of \p option.
186 * \p option must specify a valid argument in \p pa of the correct type.
188 const char *opt2parg_str(const char *option, int nparg, t_pargs pa[]);
191 * Returns value of an etENUM option.
193 * \param[in] option Name of etENUM argument to query.
194 * \param[in] nparg Number of elements in \p pa.
195 * \param[in] pa Array of arguments.
196 * \returns Value of \p option.
198 * \p option must specify a valid argument in \p pa of the correct type.
200 const char *opt2parg_enum(const char *option, int nparg, t_pargs pa[]);
203 * Returns whether an argument has been set.
205 * \param[in] option Name of argument to check.
206 * \param[in] nparg Number of elements in \p pa.
207 * \param[in] pa Array of arguments.
208 * \returns `true` if \p option has been set.
210 * \p option must specify a valid argument in \p pa.
212 gmx_bool opt2parg_bSet(const char *option, int nparg, t_pargs pa[]);
215 /** Add option -w to view output files (must be implemented in program). */
216 #define PCA_CAN_VIEW (1<<5)
217 /** Add option to set begin time for trajectory reading. */
218 #define PCA_CAN_BEGIN (1<<6)
219 /** Add option to set end time for trajectory reading. */
220 #define PCA_CAN_END (1<<7)
221 /** Add option to set time step for trajectory reading. */
222 #define PCA_CAN_DT (1<<14)
223 /** Add all options for trajectory time control. */
224 #define PCA_CAN_TIME (PCA_CAN_BEGIN | PCA_CAN_END | PCA_CAN_DT)
225 /** Add option -tu to set time unit for output. */
226 #define PCA_TIME_UNIT (1<<15)
227 /** Add option -deffnm to set default for all file options. */
228 #define PCA_CAN_SET_DEFFNM (1<<10)
229 /** Do not raise a fatal error when invalid options are encountered. */
230 #define PCA_NOEXIT_ON_ARGS (1<<11)
231 /** Do not print help output (used for non-master nodes). */
232 #define PCA_QUIET (1<<12)
233 /** Default to low priority. */
234 #define PCA_BE_NICE (1<<13)
235 /** Is this node not reading: for parallel all nodes but the master */
236 #define PCA_NOT_READ_NODE (1<<16)
239 * Parse command-line arguments.
241 * Some common default arguments are also recognized in addition to those
242 * provided through \p pa. The set of recognized default arguments is affected
245 * Recognized arguments are removed from the list.
247 gmx_bool parse_common_args(int *argc, char *argv[], unsigned long Flags,
248 int nfile, t_filenm fnm[], int npargs, t_pargs *pa,
249 int ndesc, const char **desc,
250 int nbugs, const char **bugs,