2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013, 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 * Implements classes in filenameoption.h and filenameoptionstorage.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
42 #include "filenameoption.h"
43 #include "filenameoptionstorage.h"
48 #include "gromacs/fileio/filenm.h"
50 #include "gromacs/utility/file.h"
51 #include "gromacs/utility/stringutil.h"
59 class FileTypeRegistry;
61 /********************************************************************
66 * Handles a single file type known to FileNameOptionStorage.
68 * \ingroup module_options
73 //! Returns whether \p filename has a valid extension for this type.
74 bool hasKnownExtension(const std::string &filename) const;
75 //! Adds a default extension for this type to \p filename.
76 std::string addExtension(const std::string &filename) const;
78 * Adds an extension to \p filename if it results in an existing file.
80 * Tries to add each extension for this file type to \p filename and
81 * checks whether this results in an existing file.
82 * The first match is returned.
83 * Returns an empty string if no existing file is found.
85 std::string findFileWithExtension(const std::string &filename) const;
88 //! Possible extensions for this file type.
89 std::vector<const char *> extensions_;
92 * Needed for initialization; all initialization is handled by
95 friend class FileTypeRegistry;
99 FileTypeHandler::hasKnownExtension(const std::string &filename) const
101 for (size_t i = 0; i < extensions_.size(); ++i)
103 if (endsWith(filename, extensions_[i]))
112 FileTypeHandler::addExtension(const std::string &filename) const
114 if (extensions_.empty())
118 return filename + extensions_[0];
122 FileTypeHandler::findFileWithExtension(const std::string &filename) const
124 for (size_t i = 0; i < extensions_.size(); ++i)
126 std::string testFilename(filename + extensions_[i]);
127 if (File::exists(testFilename))
132 return std::string();
135 /********************************************************************
140 * Singleton for managing static file type info for FileNameOptionStorage.
142 * \ingroup module_options
144 class FileTypeRegistry
147 //! Returns a singleton instance of this class.
148 static const FileTypeRegistry &instance();
149 //! Returns a handler for a single file type.
150 const FileTypeHandler &handlerForType(OptionFileType type) const;
153 //! Initializes the file type registry.
156 //! Registers a file type that corresponds to a ftp in filenm.h.
157 void registerType(OptionFileType type, int ftp);
158 //! Registers a file type with a single extension.
159 void registerType(OptionFileType type, const char *extension);
161 std::vector<FileTypeHandler> filetypes_;
165 const FileTypeRegistry &
166 FileTypeRegistry::instance()
168 static FileTypeRegistry singleton;
172 const FileTypeHandler &
173 FileTypeRegistry::handlerForType(OptionFileType type) const
175 GMX_RELEASE_ASSERT(type >= 0 && static_cast<size_t>(type) < filetypes_.size(),
176 "Invalid file type");
177 return filetypes_[type];
180 FileTypeRegistry::FileTypeRegistry()
182 filetypes_.resize(eftOptionFileType_NR);
183 registerType(eftTopology, efTPS);
184 registerType(eftTrajectory, efTRX);
185 registerType(eftPDB, efPDB);
186 registerType(eftIndex, efNDX);
187 registerType(eftPlot, efXVG);
188 registerType(eftGenericData, efDAT);
191 void FileTypeRegistry::registerType(OptionFileType type, int ftp)
193 GMX_RELEASE_ASSERT(type >= 0 && static_cast<size_t>(type) < filetypes_.size(),
194 "Invalid file type");
195 const int genericTypeCount = ftp2generic_count(ftp);
196 if (genericTypeCount > 0)
198 const int *const genericTypes = ftp2generic_list(ftp);
199 filetypes_[type].extensions_.clear();
200 filetypes_[type].extensions_.reserve(genericTypeCount);
201 for (int i = 0; i < genericTypeCount; ++i)
203 filetypes_[type].extensions_.push_back(ftp2ext_with_dot(genericTypes[i]));
208 registerType(type, ftp2ext_with_dot(ftp));
212 void FileTypeRegistry::registerType(OptionFileType type,
213 const char *extension)
215 GMX_RELEASE_ASSERT(type >= 0 && static_cast<size_t>(type) < filetypes_.size(),
216 "Invalid file type");
217 filetypes_[type].extensions_.assign(1, extension);
221 * Helper method to complete a file name provided to a file name option.
223 * \param[in] value Value provided to the file name option.
224 * \param[in] filetype File type for the option.
225 * \param[in] bCompleteToExisting
226 * Whether to check existing files when completing the extension.
227 * \returns \p value with possible extension added.
229 std::string completeFileName(const std::string &value, OptionFileType filetype,
230 bool bCompleteToExisting)
232 if (bCompleteToExisting && File::exists(value))
234 // TODO: This may not work as expected if the value is passed to a
235 // function that uses fn2ftp() to determine the file type and the input
236 // file has an unrecognized extension.
239 const FileTypeRegistry ®istry = FileTypeRegistry::instance();
240 const FileTypeHandler &typeHandler = registry.handlerForType(filetype);
241 if (typeHandler.hasKnownExtension(value))
245 if (bCompleteToExisting)
247 std::string newValue = typeHandler.findFileWithExtension(value);
248 if (!newValue.empty())
253 return typeHandler.addExtension(value);
258 /********************************************************************
259 * FileNameOptionStorage
262 FileNameOptionStorage::FileNameOptionStorage(const FileNameOption &settings)
263 : MyBase(settings), info_(this), filetype_(settings.filetype_),
264 bRead_(settings.bRead_), bWrite_(settings.bWrite_),
265 bLibrary_(settings.bLibrary_)
267 if (settings.defaultBasename_ != NULL)
271 setDefaultValue(completeFileName(settings.defaultBasename_,
276 setDefaultValueIfSet(completeFileName(settings.defaultBasename_,
282 std::string FileNameOptionStorage::formatSingleValue(const std::string &value) const
287 void FileNameOptionStorage::convertValue(const std::string &value)
289 bool bInput = isInputFile() || isInputOutputFile();
290 addValue(completeFileName(value, filetype_, bInput));
293 /********************************************************************
297 FileNameOptionInfo::FileNameOptionInfo(FileNameOptionStorage *option)
302 const FileNameOptionStorage &FileNameOptionInfo::option() const
304 return static_cast<const FileNameOptionStorage &>(OptionInfo::option());
307 bool FileNameOptionInfo::isInputFile() const
309 return option().isInputFile();
312 bool FileNameOptionInfo::isOutputFile() const
314 return option().isOutputFile();
317 bool FileNameOptionInfo::isInputOutputFile() const
319 return option().isInputOutputFile();
322 bool FileNameOptionInfo::isLibraryFile() const
324 return option().isLibraryFile();
327 /********************************************************************
331 AbstractOptionStoragePointer FileNameOption::createStorage() const
333 return AbstractOptionStoragePointer(new FileNameOptionStorage(*this));