2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,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 * 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 //! \addtogroup module_options
64 //! Shorthand for a list of file extensions.
65 typedef std::vector<const char *> ExtensionList;
67 /********************************************************************
72 * Handles a single file type known to FileNameOptionStorage.
77 //! Returns the list of extensions for this file type.
78 const ExtensionList &extensions() const { return extensions_; }
80 //! Returns whether \p filename has a valid extension for this type.
81 bool hasKnownExtension(const std::string &filename) const;
82 //! Adds a default extension for this type to \p filename.
83 std::string addExtension(const std::string &filename) const;
85 * Adds an extension to \p filename if it results in an existing file.
87 * Tries to add each extension for this file type to \p filename and
88 * checks whether this results in an existing file.
89 * The first match is returned.
90 * Returns an empty string if no existing file is found.
92 std::string findFileWithExtension(const std::string &filename) const;
95 //! Possible extensions for this file type.
96 ExtensionList extensions_;
99 * Needed for initialization; all initialization is handled by
102 friend class FileTypeRegistry;
106 FileTypeHandler::hasKnownExtension(const std::string &filename) const
108 for (size_t i = 0; i < extensions_.size(); ++i)
110 if (endsWith(filename, extensions_[i]))
119 FileTypeHandler::addExtension(const std::string &filename) const
121 if (extensions_.empty())
125 return filename + extensions_[0];
129 FileTypeHandler::findFileWithExtension(const std::string &filename) const
131 for (size_t i = 0; i < extensions_.size(); ++i)
133 std::string testFilename(filename + extensions_[i]);
134 if (File::exists(testFilename))
139 return std::string();
142 /********************************************************************
147 * Singleton for managing static file type info for FileNameOptionStorage.
149 class FileTypeRegistry
152 //! Returns a singleton instance of this class.
153 static const FileTypeRegistry &instance();
154 //! Returns a handler for a single file type.
155 const FileTypeHandler &handlerForType(OptionFileType type) const;
158 //! Initializes the file type registry.
161 //! Registers a file type that corresponds to a ftp in filenm.h.
162 void registerType(OptionFileType type, int ftp);
163 //! Registers a file type with a single extension.
164 void registerType(OptionFileType type, const char *extension);
166 std::vector<FileTypeHandler> filetypes_;
170 const FileTypeRegistry &
171 FileTypeRegistry::instance()
173 static FileTypeRegistry singleton;
177 const FileTypeHandler &
178 FileTypeRegistry::handlerForType(OptionFileType type) const
180 GMX_RELEASE_ASSERT(type >= 0 && static_cast<size_t>(type) < filetypes_.size(),
181 "Invalid file type");
182 return filetypes_[type];
185 FileTypeRegistry::FileTypeRegistry()
187 filetypes_.resize(eftOptionFileType_NR);
188 registerType(eftTopology, efTPS);
189 registerType(eftTrajectory, efTRX);
190 registerType(eftPDB, efPDB);
191 registerType(eftIndex, efNDX);
192 registerType(eftPlot, efXVG);
193 registerType(eftGenericData, efDAT);
196 void FileTypeRegistry::registerType(OptionFileType type, int ftp)
198 GMX_RELEASE_ASSERT(type >= 0 && static_cast<size_t>(type) < filetypes_.size(),
199 "Invalid file type");
200 const int genericTypeCount = ftp2generic_count(ftp);
201 if (genericTypeCount > 0)
203 const int *const genericTypes = ftp2generic_list(ftp);
204 filetypes_[type].extensions_.clear();
205 filetypes_[type].extensions_.reserve(genericTypeCount);
206 for (int i = 0; i < genericTypeCount; ++i)
208 filetypes_[type].extensions_.push_back(ftp2ext_with_dot(genericTypes[i]));
213 registerType(type, ftp2ext_with_dot(ftp));
217 void FileTypeRegistry::registerType(OptionFileType type,
218 const char *extension)
220 GMX_RELEASE_ASSERT(type >= 0 && static_cast<size_t>(type) < filetypes_.size(),
221 "Invalid file type");
222 filetypes_[type].extensions_.assign(1, extension);
226 * Helper method to complete a file name provided to a file name option.
228 * \param[in] value Value provided to the file name option.
229 * \param[in] filetype File type for the option.
230 * \param[in] bCompleteToExisting
231 * Whether to check existing files when completing the extension.
232 * \returns \p value with possible extension added.
234 std::string completeFileName(const std::string &value, OptionFileType filetype,
235 bool bCompleteToExisting)
237 if (bCompleteToExisting && File::exists(value))
239 // TODO: This may not work as expected if the value is passed to a
240 // function that uses fn2ftp() to determine the file type and the input
241 // file has an unrecognized extension.
244 const FileTypeRegistry ®istry = FileTypeRegistry::instance();
245 const FileTypeHandler &typeHandler = registry.handlerForType(filetype);
246 if (typeHandler.hasKnownExtension(value))
250 if (bCompleteToExisting)
252 std::string newValue = typeHandler.findFileWithExtension(value);
253 if (!newValue.empty())
258 return typeHandler.addExtension(value);
265 /********************************************************************
266 * FileNameOptionStorage
269 FileNameOptionStorage::FileNameOptionStorage(const FileNameOption &settings)
270 : MyBase(settings), info_(this), filetype_(settings.filetype_),
271 bRead_(settings.bRead_), bWrite_(settings.bWrite_),
272 bLibrary_(settings.bLibrary_)
274 if (settings.defaultBasename_ != NULL)
278 setDefaultValue(completeFileName(settings.defaultBasename_,
283 setDefaultValueIfSet(completeFileName(settings.defaultBasename_,
289 std::string FileNameOptionStorage::typeString() const
291 const FileTypeRegistry ®istry = FileTypeRegistry::instance();
292 const FileTypeHandler &typeHandler = registry.handlerForType(filetype_);
293 const ExtensionList &extensions = typeHandler.extensions();
295 ExtensionList::const_iterator i;
297 for (i = extensions.begin(); count < 2 && i != extensions.end(); ++i, ++count)
299 if (i != extensions.begin())
305 if (i != extensions.end())
307 result.append("/...");
316 std::string FileNameOptionStorage::formatExtraDescription() const
318 const FileTypeRegistry ®istry = FileTypeRegistry::instance();
319 const FileTypeHandler &typeHandler = registry.handlerForType(filetype_);
320 const ExtensionList &extensions = typeHandler.extensions();
322 if (extensions.size() > 2)
325 ExtensionList::const_iterator i;
326 for (i = extensions.begin(); i != extensions.end(); ++i)
329 result.append((*i) + 1);
335 std::string FileNameOptionStorage::formatSingleValue(const std::string &value) const
340 void FileNameOptionStorage::convertValue(const std::string &value)
342 bool bInput = isInputFile() || isInputOutputFile();
343 addValue(completeFileName(value, filetype_, bInput));
346 /********************************************************************
350 FileNameOptionInfo::FileNameOptionInfo(FileNameOptionStorage *option)
355 const FileNameOptionStorage &FileNameOptionInfo::option() const
357 return static_cast<const FileNameOptionStorage &>(OptionInfo::option());
360 bool FileNameOptionInfo::isInputFile() const
362 return option().isInputFile();
365 bool FileNameOptionInfo::isOutputFile() const
367 return option().isOutputFile();
370 bool FileNameOptionInfo::isInputOutputFile() const
372 return option().isInputOutputFile();
375 bool FileNameOptionInfo::isLibraryFile() const
377 return option().isLibraryFile();
380 /********************************************************************
384 AbstractOptionStoragePointer FileNameOption::createStorage() const
386 return AbstractOptionStoragePointer(new FileNameOptionStorage(*this));