Update instructions in containers.rst
[gromacs.git] / src / gromacs / commandline / shellcompletions.h
blob28db8f9bd5e595ddec183d77d1e12b0dc59e041a
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015,2019, 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.
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.
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.
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.
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.
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.
37 /*! \internal \file
38 * \brief
39 * Declares gmx::ShellCompletionWriter.
41 * \author Teemu Murtola <teemu.murtola@gmail.com>
42 * \ingroup module_commandline
44 #ifndef GMX_COMMANDLINE_SHELLCOMPLETIONS_H
45 #define GMX_COMMANDLINE_SHELLCOMPLETIONS_H
47 #include <string>
48 #include <vector>
50 #include "gromacs/utility/classhelpers.h"
52 namespace gmx
55 class CommandLineHelpContext;
56 class Options;
57 class TextWriter;
59 //! \cond internal
60 //! \addtogroup module_commandline
61 //! \{
63 //! Output format for ShellCompletionWriter.
64 enum ShellCompletionFormat
66 eShellCompletionFormat_Bash //!< Shell completions for bash.
69 //! \}
70 //! \endcond
72 class ShellCompletionWriter
74 public:
75 typedef std::vector<std::string> ModuleNameList;
77 ShellCompletionWriter(const std::string& binaryName, ShellCompletionFormat format);
78 ~ShellCompletionWriter();
80 TextWriter& outputWriter();
82 void startCompletions();
83 void writeModuleCompletions(const char* moduleName, const Options& options);
84 void writeWrapperCompletions(const ModuleNameList& modules, const Options& options);
85 void finishCompletions();
87 private:
88 class Impl;
90 PrivateImplPointer<Impl> impl_;
93 } // namespace gmx
95 #endif