/*
* This file is part of the GROMACS molecular simulation package.
*
- * Copyright (c) 2012, by the GROMACS development team, led by
+ * 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.
#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
//! Initializes an option with the given name.
explicit FileNameOption(const char *name)
- : MyBase(name), filetype_(eftUnknown), defaultBasename_(NULL),
+ : 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.
* directories. It would be nicer to do this searching within the
* file name option implementation.
*/
- MyClass &libraryFile() { bLibrary_ = true; return me(); }
+ 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().
+ * 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
- * defaultValue(), otherwise it is treated as for defaultValueIfSet().
+ * 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 &defaultType(int filetype)
+ { defaultType_ = filetype; return me(); }
private:
// Use defaultBasename() instead.
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_;
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);
*/
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;
};
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff