Shell completion export from the wrapper binary
[alexxy/gromacs.git] / 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> (C++ interface)
42  */
43 #ifndef GMX_COMMANDLINE_SHELLCOMPLETIONS_H
44 #define GMX_COMMANDLINE_SHELLCOMPLETIONS_H
45
46 #include <string>
47 #include <vector>
48
49 #include "gromacs/commandline/pargs.h"
50 #include "gromacs/fileio/filenm.h"
51 #include "gromacs/utility/common.h"
52
53 namespace gmx
54 {
55
56 class CommandLineHelpContext;
57 class File;
58 class Options;
59
60 //! \cond internal
61 //! \addtogroup module_onlinehelp
62 //! \{
63
64 //! Output format for ShellCompletionWriter.
65 enum ShellCompletionFormat
66 {
67     eShellCompletionFormat_Bash         //!< Shell completions for bash.
68 };
69
70 //! \}
71 //! \endcond
72
73 class ShellCompletionWriter
74 {
75     public:
76         typedef std::vector<std::string> ModuleNameList;
77
78         ShellCompletionWriter(const std::string     &binaryName,
79                               ShellCompletionFormat  format);
80         ~ShellCompletionWriter();
81
82         File *outputFile();
83
84         void startCompletions();
85         void writeLegacyModuleCompletions(const char *moduleName,
86                                           int nfile,  t_filenm *fnm,
87                                           int npargs, t_pargs *pa);
88         void writeModuleCompletions(const char    *moduleName,
89                                     const Options &options);
90         void writeWrapperCompletions(const ModuleNameList &modules);
91         void finishCompletions();
92
93     private:
94         class Impl;
95
96         PrivateImplPointer<Impl> impl_;
97 };
98
99 } // namespace gmx
100
101 #endif