src/gromacs/options/ioptionsbehavior.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015, 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::IOptionsBehavior.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_IOPTIONSBEHAVIOR_H
  44 #define GMX_OPTIONS_IOPTIONSBEHAVIOR_H
  45
  46 namespace gmx
  47 {
  48
  49 class Options;
  50
  51 /*! \brief
  52  * Interface to provide extension points for options parsing.
  53  *
  54  * Currently, this is only used in the context of ICommandLineOptionsModule and
  55  * some other command-line handling, but it is declared in the options module
  56  * for the lack of a better place: most implementations of the interface are in
  57  * modules that do not otherwise depend on the commandline module.
  58  *
  59  * \if libapi
  60  * Any code that wants to support these extension points needs to use
  61  * OptionsBehaviorCollection and call the methods there at appropriate points.
  62  * This is not (at least, not currently) integrated in any automatic way to the
  63  * actual Options object.
  64  * \endif
  65  *
  66  * \inpublicapi
  67  * \ingroup module_options
  68  */
  69 class IOptionsBehavior
  70 {
  71     public:
  72         virtual ~IOptionsBehavior();
  73
  74         /*! \brief
  75          * Called when the behavior is associated with an options object.
  76          *
  77          * This method can, e.g., use Options::addManager() to associate
  78          * managers with the options object.
  79          */
  80         virtual void initBehavior(Options *options) = 0;
  81         /*! \brief
  82          * Called when all option values have been assigned.
  83          *
  84          * This is called just before Options::finish(), and can, e.g., do
  85          * operations that still influence the option values.
  86          */
  87         virtual void optionsFinishing(Options *options) = 0;
  88         /*! \brief
  89          * Called when all option values have been processed.
  90          *
  91          * This is called after Options::finish() (and typically after
  92          * higher-level optionsFinished() methods, such as that in
  93          * ICommandLineOptionsModule).  This can add behavior that performs
  94          * tasks based on the option values provided.
  95          */
  96         virtual void optionsFinished() = 0;
  97 };
  98
  99 } // namespace
 100
 101 #endif