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