src/gromacs/commandline/shellcompletions.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \internal \file
  38  * \brief
  39  * Declares gmx::ShellCompletionWriter.
  40  *
  41  * \author Teemu Murtola <teemu.murtola@gmail.com>
  42  * \ingroup module_commandline
  43  */
  44 #ifndef GMX_COMMANDLINE_SHELLCOMPLETIONS_H
  45 #define GMX_COMMANDLINE_SHELLCOMPLETIONS_H
  46
  47 #include <string>
  48 #include <vector>
  49
  50 #include "gromacs/utility/common.h"
  51
  52 namespace gmx
  53 {
  54
  55 class CommandLineHelpContext;
  56 class File;
  57 class Options;
  58
  59 //! \cond internal
  60 //! \addtogroup module_onlinehelp
  61 //! \{
  62
  63 //! Output format for ShellCompletionWriter.
  64 enum ShellCompletionFormat
  65 {
  66     eShellCompletionFormat_Bash         //!< Shell completions for bash.
  67 };
  68
  69 //! \}
  70 //! \endcond
  71
  72 class ShellCompletionWriter
  73 {
  74     public:
  75         typedef std::vector<std::string> ModuleNameList;
  76
  77         ShellCompletionWriter(const std::string     &binaryName,
  78                               ShellCompletionFormat  format);
  79         ~ShellCompletionWriter();
  80
  81         File *outputFile();
  82
  83         void startCompletions();
  84         void writeModuleCompletions(const char    *moduleName,
  85                                     const Options &options);
  86         void writeWrapperCompletions(const ModuleNameList &modules,
  87                                      const Options        &options);
  88         void finishCompletions();
  89
  90     private:
  91         class Impl;
  92
  93         PrivateImplPointer<Impl> impl_;
  94 };
  95
  96 } // namespace gmx
  97
  98 #endif