src/gromacs/commandline.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,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 /*! \defgroup module_commandline Command Line Program Management (commandline)
  36  * \ingroup group_utilitymodules
  37  * \brief
  38  * Provides functionality for managing command line programs.
  39  *
  40  * This module provides utility classes and functions for implementing command
  41  * line programs.  They are mainly used within \Gromacs, but can also be used
  42  * from external programs if they want to get a similar user experience to
  43  * \Gromacs tools.
  44  *
  45  * The classes exposed from this module can be roughly divided into two groups:
  46  *
  47  *  - Helper classes/functions for implementing the %main() function.
  48  *    See \ref page_usinglibrary for an overview of those available for user
  49  *    programs.  These are declared in cmdlineinit.h
  50  *    (gmx::CommandLineModuleInterface is declared in cmdlinemodule.h).
  51  *    \if libapi
  52  *
  53  *    Additionally, for internal \Gromacs use, gmx::CommandLineModuleManager
  54  *    provides the functionality to implement the `gmx` wrapper binary, as well
  55  *    as command line options common to all \Gromacs programs (such as
  56  *    `-version`).
  57  *    This is described in more detail at \ref page_wrapperbinary.
  58  *    \endif
  59  *
  60  *  - Helper classes for particular command line tasks:
  61  *     - gmx::CommandLineParser implements command line parsing to assign
  62  *       values to gmx::Options (see \ref module_options).
  63  *     - gmx::CommandLineHelpWriter writes help text for a program that uses
  64  *       the parser.
  65  *     - parse_common_args() is an old interface to \Gromacs command line
  66  *       parsing.  This is still used by many parts of \Gromacs.
  67  *
  68  * \author Teemu Murtola <teemu.murtola@gmail.com>
  69  */
  70 /*! \file
  71  * \brief
  72  * Public API convenience header for managing command line programs.
  73  *
  74  * \author Teemu Murtola <teemu.murtola@gmail.com>
  75  * \inpublicapi
  76  * \ingroup module_commandline
  77  */
  78 #ifndef GMX_COMMANDLINE_H
  79 #define GMX_COMMANDLINE_H
  80
  81 #include "commandline/cmdlinehelpwriter.h"
  82 #include "commandline/cmdlineinit.h"
  83 #include "commandline/cmdlinemodule.h"
  84 #include "commandline/cmdlineparser.h"
  85 #include "commandline/pargs.h"
  86
  87 #endif