/usr/include/gromacs/options/ioptionsbehavior.h is in libgromacs-dev 2018.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | /*
* This file is part of the GROMACS molecular simulation package.
*
* Copyright (c) 2015, 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.
*
* GROMACS is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* GROMACS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with GROMACS; if not, see
* http://www.gnu.org/licenses, or write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* If you want to redistribute modifications to GROMACS, please
* consider that scientific software is very special. Version
* control is crucial - bugs must be traceable. We will be happy to
* consider code for inclusion in the official distribution, but
* derived work must not be called official GROMACS. Details are found
* in the README & COPYING files - if they are missing, get the
* official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
* the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \file
* \brief
* Declares gmx::IOptionsBehavior.
*
* \author Teemu Murtola <teemu.murtola@gmail.com>
* \inpublicapi
* \ingroup module_options
*/
#ifndef GMX_OPTIONS_IOPTIONSBEHAVIOR_H
#define GMX_OPTIONS_IOPTIONSBEHAVIOR_H
namespace gmx
{
class Options;
/*! \brief
* Interface to provide extension points for options parsing.
*
* Currently, this is only used in the context of ICommandLineOptionsModule and
* some other command-line handling, but it is declared in the options module
* for the lack of a better place: most implementations of the interface are in
* modules that do not otherwise depend on the commandline module.
*
* \if libapi
* Any code that wants to support these extension points needs to use
* OptionsBehaviorCollection and call the methods there at appropriate points.
* This is not (at least, not currently) integrated in any automatic way to the
* actual Options object.
* \endif
*
* \inpublicapi
* \ingroup module_options
*/
class IOptionsBehavior
{
public:
virtual ~IOptionsBehavior();
/*! \brief
* Called when the behavior is associated with an options object.
*
* This method can, e.g., use Options::addManager() to associate
* managers with the options object.
*/
virtual void initBehavior(Options *options) = 0;
/*! \brief
* Called when all option values have been assigned.
*
* This is called just before Options::finish(), and can, e.g., do
* operations that still influence the option values.
*/
virtual void optionsFinishing(Options *options) = 0;
/*! \brief
* Called when all option values have been processed.
*
* This is called after Options::finish() (and typically after
* higher-level optionsFinished() methods, such as that in
* ICommandLineOptionsModule). This can add behavior that performs
* tasks based on the option values provided.
*/
virtual void optionsFinished() = 0;
};
} // namespace
#endif
|