2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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.
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.
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.
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.
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.
37 * Declares gmx::FileNameOptionManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_options
43 #ifndef GMX_OPTIONS_FILENAMEOPTIONMANAGER_H
44 #define GMX_OPTIONS_FILENAMEOPTIONMANAGER_H
48 #include "gromacs/options/options.h"
49 #include "gromacs/utility/common.h"
54 class FileNameOptionInfo;
58 * Handles interaction of file name options with global options.
60 * This class contains all logic that completes file names based on user input
61 * and file system contents. Additionally, this class implements support for a
62 * global default file name that overrides any option-specific default, as well
63 * as additional control over how the completion is done.
66 * Most of the functionality in this class is specific to command line parsing,
67 * so it would be cleaner to replace this with an interface, and have the
68 * actual code in the `commandline` module.
70 * Adding a FileNameOptionManager for an Options object is optional, even if
71 * the Options contains FileNameOption options. Features from the manager are
72 * not available if the manager is not created, but otherwise the options work:
73 * the values provided to FileNameOption are used as they are, and exceptions
74 * are thrown if they are no valid instead of attempting to complete them.
76 * \see Options::addManager()
79 * \ingroup module_selection
81 class FileNameOptionManager : public OptionManagerInterface
84 FileNameOptionManager();
85 virtual ~FileNameOptionManager();
88 * Disables special input file option handling.
90 * If disabled, this removes all file system calls from the file
91 * name option parsing.
92 * The values returned by FileNameOption for input and input/output
93 * files are handled with the same simple rule as for output files:
94 * the default extension is added if the file does not end in a
95 * recognized extension, and no other checking is done.
97 * This changes the following behavior:
98 * - Providing non-existent files does not trigger errors.
99 * - Extensions for input files are not completed to an existing file.
100 * - Compressed input files do not work.
102 void disableInputOptionChecking(bool bDisable);
105 * Adds an option for setting the default global file name.
107 * \param options Options to add the option to.
108 * \param[in] name Name of the option to add.
110 * If the user sets the option, it affects all file name options that
111 * would normally return a default value: the basename for the returned
112 * value is taken from the value of the default file name option,
113 * instead from an option-specific default
114 * (FileNameOption::defaultBaseName()).
116 void addDefaultFileNameOption(Options *options, const char *name);
119 * Completes file name option values.
121 * \param[in] value Value provided by the user.
122 * \param[in] option Option for which the value should be completed.
123 * \returns Value for the file name option.
124 * \throws std::bad_alloc if out of memory.
125 * \throws InvalidInputError if the value is not valid for this
128 * This method is called for each value that the user provides to
129 * a FileNameOption. The return value (if non-empty) is used as the
130 * value of the option instead of the user-provided one.
132 std::string completeFileName(const std::string &value,
133 const FileNameOptionInfo &option);
135 * Completes default values for file name options.
137 * \param[in] prefix Default prefix for the file name.
138 * \param[in] option Option for which the value should be completed.
139 * \returns Value for the file name option.
140 * \throws std::bad_alloc if out of memory.
141 * \throws InvalidInputError if the value is not valid for this
144 * This method is called for each FileNameOption that has a default
145 * value (either a standard default value, or if the user provided the
146 * option without an explicit value). \p prefix is the default value
147 * without the default extension for the option.
148 * If the return value is non-empty, it is used as the default value
149 * for the option instead of \p prefix + default extension.
151 std::string completeDefaultFileName(const std::string &prefix,
152 const FileNameOptionInfo &option);
157 PrivateImplPointer<Impl> impl_;