src/gromacs/options/filenameoptionmanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \file
  36  * \brief
  37  * Declares gmx::FileNameOptionManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_FILENAMEOPTIONMANAGER_H
  44 #define GMX_OPTIONS_FILENAMEOPTIONMANAGER_H
  45
  46 #include <string>
  47
  48 #include "gromacs/options/options.h"
  49 #include "gromacs/utility/classhelpers.h"
  50
  51 namespace gmx
  52 {
  53
  54 class FileNameOptionInfo;
  55 class IFileInputRedirector;
  56 class IOptionsContainer;
  57
  58 /*! \brief
  59  * Handles interaction of file name options with global options.
  60  *
  61  * This class contains all logic that completes file names based on user input
  62  * and file system contents.  Additionally, this class implements support for a
  63  * global default file name that overrides any option-specific default, as well
  64  * as additional control over how the completion is done.
  65  *
  66  * \todo
  67  * Most of the functionality in this class is specific to command line parsing,
  68  * so it would be cleaner to replace this with an interface, and have the
  69  * actual code in the `commandline` module.
  70  *
  71  * Adding a FileNameOptionManager for an Options object is optional, even if
  72  * the Options contains FileNameOption options.  Features from the manager are
  73  * not available if the manager is not created, but otherwise the options work:
  74  * the values provided to FileNameOption are used as they are, and exceptions
  75  * are thrown if they are no valid instead of attempting to complete them.
  76  *
  77  * \see Options::addManager()
  78  *
  79  * \inpublicapi
  80  * \ingroup module_selection
  81  */
  82 class FileNameOptionManager : public IOptionManager
  83 {
  84 public:
  85     FileNameOptionManager();
  86     ~FileNameOptionManager() override;
  87
  88     /*! \brief
  89      * Redirects file existence checks.
  90      *
  91      * \param[in] redirector  File redirector to use for existence checks.
  92      *
  93      * The manager checks for existence of various files on the file system
  94      * to complete file extensions.  This method can be used to redirect
  95      * those checks to an alternative implementation.
  96      *
  97      * This is used for unit tests to more easily control the result of the
  98      * checks and to keep the tests as fast as possible by avoiding real
  99      * file system access.  To keep implementation options open, behavior
 100      * with `redirector == NULL` is undefined and should not be relied on.
 101      * For tests, there should only be need to call this a single time,
 102      * right after creating the manager.
 103      */
 104     void setInputRedirector(const IFileInputRedirector* redirector);
 105
 106     /*! \brief
 107      * Disables special input file option handling.
 108      *
 109      * If disabled, this removes all file system calls from the file
 110      * name option parsing.
 111      * The values returned by FileNameOption for input and input/output
 112      * files are handled with the same simple rule as for output files:
 113      * the default extension is added if the file does not end in a
 114      * recognized extension, and no other checking is done.
 115      *
 116      * This changes the following behavior:
 117      *  - Providing non-existent files does not trigger errors.
 118      *  - Extensions for input files are not completed to an existing file.
 119      *  - Compressed input files do not work.
 120      */
 121     void disableInputOptionChecking(bool bDisable);
 122
 123     /*! \brief
 124      * Adds an option for setting the default global file name.
 125      *
 126      * \param     options Options to add the option to.
 127      * \param[in] name    Name of the option to add.
 128      *
 129      * If the user sets the option, it affects all file name options that
 130      * would normally return a default value: the basename for the returned
 131      * value is taken from the value of the default file name option,
 132      * instead from an option-specific default
 133      * (FileNameOption::defaultBaseName()).
 134      */
 135     void addDefaultFileNameOption(IOptionsContainer* options, const char* name);
 136
 137     /*! \brief
 138      * Completes file name option values.
 139      *
 140      * \param[in] value  Value provided by the user.
 141      * \param[in] option Option for which the value should be completed.
 142      * \returns   Value for the file name option.
 143      * \throws    std::bad_alloc if out of memory.
 144      * \throws    InvalidInputError if the value is not valid for this
 145      *     option.
 146      *
 147      * This method is called for each value that the user provides to
 148      * a FileNameOption.  The return value (if non-empty) is used as the
 149      * value of the option instead of the user-provided one.
 150      */
 151     std::string completeFileName(const std::string& value, const FileNameOptionInfo& option);
 152     /*! \brief
 153      * Completes default values for file name options.
 154      *
 155      * \param[in] prefix Default prefix for the file name.
 156      * \param[in] option Option for which the value should be completed.
 157      * \returns   Value for the file name option.
 158      * \throws    std::bad_alloc if out of memory.
 159      * \throws    InvalidInputError if the value is not valid for this
 160      *     option.
 161      *
 162      * This method is called for each FileNameOption that has a default
 163      * value (either a standard default value, or if the user provided the
 164      * option without an explicit value).  \p prefix is the default value
 165      * without the default extension for the option.
 166      * If the return value is non-empty, it is used as the default value
 167      * for the option instead of \p prefix + default extension.
 168      */
 169     std::string completeDefaultFileName(const std::string& prefix, const FileNameOptionInfo& option);
 170
 171 private:
 172     class Impl;
 173
 174     PrivateImplPointer<Impl> impl_;
 175 };
 176
 177 } // namespace gmx
 178
 179 #endif