2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2016,2017,2018,2019, 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::FileNameOptionStorage.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
42 #ifndef GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
43 #define GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
48 #include "gromacs/options/filenameoption.h"
49 #include "gromacs/options/optionfiletype.h"
50 #include "gromacs/options/optionstoragetemplate.h"
56 class FileNameOptionManager;
59 * Converts, validates, and stores file names.
61 class FileNameOptionStorage : public OptionStorageTemplateSimple<std::string>
65 * Initializes the storage from option settings.
67 * \param[in] settings Storage settings.
68 * \param manager Manager for this object (can be NULL).
70 FileNameOptionStorage(const FileNameOption& settings, FileNameOptionManager* manager);
72 OptionInfo& optionInfo() override { return info_; }
73 std::string typeString() const override;
74 std::string formatExtraDescription() const override;
75 std::string formatSingleValue(const std::string& value) const override;
77 //! \copydoc FileNameOptionInfo::isInputFile()
78 bool isInputFile() const { return bRead_ && !bWrite_; }
79 //! \copydoc FileNameOptionInfo::isOutputFile()
80 bool isOutputFile() const { return !bRead_ && bWrite_; }
81 //! \copydoc FileNameOptionInfo::isInputOutputFile()
82 bool isInputOutputFile() const { return bRead_ && bWrite_; }
83 //! \copydoc FileNameOptionInfo::isLibraryFile()
84 bool isLibraryFile() const { return bLibrary_; }
85 //! \copydoc FileNameOptionInfo::allowMissing()
86 bool allowMissing() const { return bAllowMissing_; }
88 //! \copydoc FileNameOptionInfo::isDirectoryOption()
89 bool isDirectoryOption() const;
90 //! \copydoc FileNameOptionInfo::isTrajectoryOption()
91 bool isTrajectoryOption() const;
92 //! \copydoc FileNameOptionInfo::defaultExtension()
93 const char* defaultExtension() const;
94 //! \copydoc FileNameOptionInfo::extensions()
95 std::vector<const char*> extensions() const;
96 //! \copydoc FileNameOptionInfo::isValidType()
97 bool isValidType(int fileType) const;
98 //! \copydoc FileNameOptionInfo::fileTypes()
99 ArrayRef<const int> fileTypes() const;
102 void initConverter(ConverterType* converter) override;
103 std::string processValue(const std::string& value) const override;
104 void processAll() override;
106 FileNameOptionInfo info_;
107 FileNameOptionManager* manager_;
109 const char* defaultExtension_;