/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \file
* \brief
- * Declares gmx::FileNameOption for setting file name options.
+ * Declares gmx::FileNameOption and gmx::FileNameOptionInfo.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \inpublicapi
* \ingroup module_options
*/
#define GMX_OPTIONS_FILENAMEOPTION_H
#include <string>
+#include <vector>
#include "abstractoption.h"
#include "optionfiletype.h"
namespace gmx
{
+template <typename T> class ConstArrayRef;
+class FileNameOptionInfo;
+class FileNameOptionManager;
class FileNameOptionStorage;
/*! \brief
*
* Public methods in this class do not throw.
*
- * This class is currently a stub implementation.
- *
* \inpublicapi
* \ingroup module_options
*/
class FileNameOption : public OptionTemplate<std::string, FileNameOption>
{
public:
+ //! OptionInfo subclass corresponding to this option type.
+ typedef FileNameOptionInfo InfoType;
+
//! Initializes an option with the given name.
explicit FileNameOption(const char *name)
- : MyBase(name), filetype_(eftUnknown),
+ : MyBase(name), optionType_(eftUnknown), legacyType_(-1),
+ defaultBasename_(NULL), defaultType_(-1),
+ bLegacyOptionalBehavior_(false),
bRead_(false), bWrite_(false), bLibrary_(false)
{
}
/*! \brief
* Sets the type of the file this option accepts.
*
- * This attribute must be provided.
+ * Either this attribute or legacyType() must be provided.
*/
MyClass &filetype(OptionFileType type)
- { filetype_ = type; return me(); }
+ { optionType_ = type; return me(); }
+ /*! \brief
+ * Sets the type of the file from an enum in filenm.h.
+ *
+ * New code should prefer filetype(), extending the enumeration if
+ * necessary.
+ */
+ MyClass &legacyType(int type)
+ { legacyType_ = type; return me(); }
+ /*! \brief
+ * Changes the behavior of optional options to match old t_filenm.
+ *
+ * If this is not set, optional options return an empty string if not
+ * set. If this is set, a non-empty value is always returned.
+ * In the latter case, whether the option is set only affects the
+ * return value of OptionInfo::isSet() and Options::isSet().
+ */
+ MyClass &legacyOptionalBehavior()
+ { bLegacyOptionalBehavior_ = true; return me(); }
//! Tells that the file provided by this option is used for input only.
MyClass &inputFile()
{ bRead_ = true; bWrite_ = false; return me(); }
*/
MyClass &inputOutputFile()
{ bRead_ = bWrite_ = true; return me(); }
+ /*! \brief
+ * Sets the read/write usage for this file from boolean flags.
+ */
+ MyClass &readWriteFlags(bool bRead, bool bWrite)
+ { bRead_ = bRead; bWrite_ = bWrite; return me(); }
/*! \brief
* Tells that the file will be looked up in library directories in
* addition to working directory.
+ *
+ * \todo
+ * Currently, this flag only affects the help output. Callers must
+ * take care themselves to actually search the file in the library
+ * directories. It would be nicer to do this searching within the
+ * file name option implementation.
+ */
+ MyClass &libraryFile(bool bLibrary = true)
+ { bLibrary_ = bLibrary; return me(); }
+ /*! \brief
+ * Sets a default basename for the file option.
+ *
+ * Use this method instead of defaultValue() or defaultValueIfSet() to
+ * set a default value for a file name option. No extension needs to
+ * be provided; it is automatically added based on filetype() or
+ * defaultType().
+ * The behavior is also adjusted based on required(): if the option is
+ * required, the value given to defaultBasename() is treated as for
+ * both defaultValue() and defaultValueIfSet(), otherwise it is treated
+ * as for defaultValueIfSet().
+ *
+ * For input files that accept multiple extensions, the extension is
+ * completed to the default extension on creation of the option or at
+ * time of parsing an option without a value.
+ *
+ * If FileNameOptionManager is used, the extension may change during
+ * Options::finish(), as this is the time when the default names are
+ * checked against the file system to provide an extension that matches
+ * an existing file if that is possible.
+ *
+ * If FileNameOptionManager is used, and
+ * FileNameOptionManager::addDefaultFileNameOption() is used, and the
+ * user provides a global default file name using that option, then the
+ * global default takes precedence over defaultBasename().
+ */
+ MyClass &defaultBasename(const char *basename)
+ { defaultBasename_ = basename; return me(); }
+ /*! \brief
+ * Sets a default type/extension for the file option.
+ *
+ * For options that accept multiple types of files (e.g.,
+ * eftTrajectory), this method sets the default extension used
+ * for completing defaultBasename(), as well as the default extension
+ * used by FileNameOptionManager to complete various file names.
+ *
+ * The value should be one of the enumerated `ef*` values from
+ * filenm.h, and be a valid type for the type specified with
+ * filetype().
*/
- MyClass &libraryFile() { bLibrary_ = true; return me(); }
+ MyClass &defaultType(int filetype)
+ { defaultType_ = filetype; return me(); }
private:
+ // Use defaultBasename() instead.
+ using MyBase::defaultValue;
+ using MyBase::defaultValueIfSet;
+
//! Creates a FileNameOptionStorage object.
- virtual AbstractOptionStoragePointer createStorage() const;
+ virtual AbstractOptionStorage *createStorage(
+ const OptionManagerContainer &managers) const;
- OptionFileType filetype_;
+ OptionFileType optionType_;
+ int legacyType_;
+ const char *defaultBasename_;
+ int defaultType_;
+ bool bLegacyOptionalBehavior_;
bool bRead_;
bool bWrite_;
bool bLibrary_;
friend class FileNameOptionStorage;
};
+/*! \brief
+ * Wrapper class for accessing file name option information.
+ *
+ * \inpublicapi
+ * \ingroup module_options
+ */
+class FileNameOptionInfo : public OptionInfo
+{
+ public:
+ //! Shorthand for a list of extensions.
+ typedef std::vector<const char *> ExtensionList;
+
+ //! Creates an option info object for the given option.
+ explicit FileNameOptionInfo(FileNameOptionStorage *option);
+
+ //! Whether the option specifies an input file.
+ bool isInputFile() const;
+ //! Whether the option specifies an output file.
+ bool isOutputFile() const;
+ //! Whether the option specifies a file used for both input and output.
+ bool isInputOutputFile() const;
+ /*! \brief
+ * Whether the option specifies a library file.
+ *
+ * \see FileNameOption::libraryFile()
+ */
+ bool isLibraryFile() const;
+
+ //! Whether the option specifies directories.
+ bool isDirectoryOption() const;
+ //! Whether the option specifies a generic trajectory file.
+ bool isTrajectoryOption() const;
+ //! Returns the default extension for this option.
+ const char *defaultExtension() const;
+ //! Returns the list of extensions this option accepts.
+ ExtensionList extensions() const;
+ //! Returns whether \p fileType (from filenm.h) is accepted for this option.
+ bool isValidType(int fileType) const;
+ //! Returns the list of file types this option accepts.
+ ConstArrayRef<int> fileTypes() const;
+
+ private:
+ const FileNameOptionStorage &option() const;
+};
+
} // namespace gmx
#endif
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff