src/gromacs/options/filenameoptionmanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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.
   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 "options.h"
  49
  50 #include "../utility/common.h"
  51
  52 namespace gmx
  53 {
  54
  55 class Options;
  56
  57 /*! \brief
  58  * Handles interaction of file name options with global options.
  59  *
  60  * Currently, this class implements support for a global default file name
  61  * that overrides any option-specific default.
  62  *
  63  * \todo
  64  * Currently, this class has very little logic, and just provides the global
  65  * values to FileNameOptionStorage implementation.  A cleaner design would have
  66  * most of the non-trivial file name completion logic in this class, so that
  67  * the customizations would be centralized here.
  68  *
  69  * Adding a FileNameOptionManager for an Options object is optional, even if
  70  * the Options contains FileNameOption options.  Features from the manager are
  71  * not available if the manager is not created, but otherwise the options work.
  72  *
  73  * \see Options::addManager()
  74  *
  75  * \inpublicapi
  76  * \ingroup module_selection
  77  */
  78 class FileNameOptionManager : public OptionManagerInterface
  79 {
  80     public:
  81         FileNameOptionManager();
  82         virtual ~FileNameOptionManager();
  83
  84         /*! \brief
  85          * Adds an option for setting the default global file name.
  86          *
  87          * \param     options Options to add the option to.
  88          * \param[in] name    Name of the option to add.
  89          *
  90          * If the user sets the option, it affects all file name options that
  91          * would normally return a default value: the basename for the returned
  92          * value is taken from the value of the default file name option,
  93          * instead from an option-specific default
  94          * (FileNameOption::defaultBaseName()).
  95          */
  96         void addDefaultFileNameOption(Options *options, const char *name);
  97
  98         //! Returns the currently set default file name.
  99         const std::string &defaultFileName() const;
 100
 101     private:
 102         class Impl;
 103
 104         PrivateImplPointer<Impl> impl_;
 105 };
 106
 107 } // namespace gmx
 108
 109 #endif