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, 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.
39 * Implements gmx::ShellCompletionWriter.
41 * \author Teemu Murtola <teemu.murtola@gmail.com>
42 * \ingroup module_commandline
44 #include "gromacs/commandline/shellcompletions.h"
50 #include <boost/scoped_ptr.hpp>
52 #include "gromacs/commandline/cmdlinehelpcontext.h"
53 #include "gromacs/commandline/pargs.h"
54 #include "gromacs/options/basicoptions.h"
55 #include "gromacs/options/filenameoption.h"
56 #include "gromacs/options/optionsvisitor.h"
57 #include "gromacs/fileio/filenm.h"
58 #include "gromacs/utility/arrayref.h"
59 #include "gromacs/utility/exceptions.h"
60 #include "gromacs/utility/file.h"
61 #include "gromacs/utility/gmxassert.h"
62 #include "gromacs/utility/stringutil.h"
70 class OptionsListWriter : public OptionsVisitor
73 const std::string &optionList() const { return optionList_; }
75 virtual void visitSubSection(const Options §ion)
77 OptionsIterator iterator(section);
78 iterator.acceptSubSections(this);
79 iterator.acceptOptions(this);
81 virtual void visitOption(const OptionInfo &option)
83 if (option.isHidden())
87 if (!optionList_.empty())
89 optionList_.append("\\n");
91 optionList_.append("-");
92 const BooleanOptionInfo *booleanOption
93 = option.toType<BooleanOptionInfo>();
94 if (booleanOption != NULL && booleanOption->defaultValue())
96 optionList_.append("no");
98 optionList_.append(option.name());
102 std::string optionList_;
105 class OptionCompletionWriter : public OptionsVisitor
108 explicit OptionCompletionWriter(File *out) : out_(*out) {}
110 virtual void visitSubSection(const Options §ion)
112 OptionsIterator iterator(section);
113 iterator.acceptSubSections(this);
114 iterator.acceptOptions(this);
116 virtual void visitOption(const OptionInfo &option);
119 void writeOptionCompletion(const OptionInfo &option,
120 const std::string &completion);
125 void OptionCompletionWriter::visitOption(const OptionInfo &option)
127 if (option.isHidden())
131 const FileNameOptionInfo *fileOption = option.toType<FileNameOptionInfo>();
132 if (fileOption != NULL)
134 if (fileOption->isDirectoryOption())
136 writeOptionCompletion(option, "compgen -S ' ' -d $c");
139 const FileNameOptionInfo::ExtensionList &extensionList = fileOption->extensions();
140 if (extensionList.empty())
144 std::string completion("compgen -S ' ' -X '!*");
145 std::string extensions(joinStrings(extensionList, "|"));
146 if (extensionList.size() > 1)
148 extensions = "@(" + extensions + ")";
150 completion.append(extensions);
151 // TODO: Don't duplicate this from filenm.c/futil.c.
152 completion.append("?(.gz|.Z)' -f -- $c ; compgen -S '/' -d $c");
153 writeOptionCompletion(option, completion);
156 const StringOptionInfo *stringOption = option.toType<StringOptionInfo>();
157 if (stringOption != NULL && stringOption->isEnumerated())
159 std::string completion("compgen -S ' ' -W $'");
160 completion.append(joinStrings(stringOption->allowedValues(), "\\n"));
161 completion.append("' -- $c");
162 writeOptionCompletion(option, completion);
167 void OptionCompletionWriter::writeOptionCompletion(
168 const OptionInfo &option, const std::string &completion)
170 std::string result(formatString("-%s) ", option.name().c_str()));
171 if (option.maxValueCount() >= 0)
173 result.append(formatString("(( $n <= %d )) && ", option.maxValueCount()));
175 result.append("COMPREPLY=( $(");
176 result.append(completion);
177 result.append("));;");
178 out_.writeLine(result);
183 class ShellCompletionWriter::Impl
186 Impl(const std::string &binaryName, ShellCompletionFormat /*format*/)
187 : binaryName_(binaryName)
191 std::string completionFunctionName(const char *moduleName) const
193 // TODO: Consider if some characters need to be escaped.
194 return formatString("_%s_%s_compl", binaryName_.c_str(), moduleName);
197 std::string binaryName_;
198 boost::scoped_ptr<File> file_;
201 ShellCompletionWriter::ShellCompletionWriter(const std::string &binaryName,
202 ShellCompletionFormat format)
203 : impl_(new Impl(binaryName, format))
207 ShellCompletionWriter::~ShellCompletionWriter()
211 File *ShellCompletionWriter::outputFile()
213 return impl_->file_.get();
216 void ShellCompletionWriter::startCompletions()
218 impl_->file_.reset(new File(impl_->binaryName_ + "-completion.bash", "w"));
219 impl_->file_->writeLine("shopt -s extglob");
222 void ShellCompletionWriter::writeModuleCompletions(
223 const char *moduleName,
224 const Options &options)
226 File &out = *impl_->file_;
227 out.writeLine(formatString("%s() {", impl_->completionFunctionName(moduleName).c_str()));
228 out.writeLine("local IFS=$'\\n'");
229 out.writeLine("local c=${COMP_WORDS[COMP_CWORD]}");
230 out.writeLine("local n");
231 out.writeLine("for ((n=1;n<COMP_CWORD;++n)) ; do [[ \"${COMP_WORDS[COMP_CWORD-n]}\" == -* ]] && break ; done");
232 out.writeLine("local p=${COMP_WORDS[COMP_CWORD-n]}");
233 out.writeLine("COMPREPLY=()");
235 OptionsListWriter listWriter;
236 listWriter.visitSubSection(options);
237 out.writeLine(formatString("if (( $COMP_CWORD <= 1 )) || [[ $c == -* ]]; then COMPREPLY=( $(compgen -S ' ' -W $'%s' -- $c)); return 0; fi", listWriter.optionList().c_str()));
239 out.writeLine("case \"$p\" in");
240 OptionCompletionWriter optionWriter(&out);
241 optionWriter.visitSubSection(options);
242 out.writeLine("esac }");
245 void ShellCompletionWriter::writeWrapperCompletions(
246 const ModuleNameList &modules, const Options &options)
248 impl_->file_->writeLine("_" + impl_->binaryName_ + "_compl() {");
249 impl_->file_->writeLine("local i c m");
250 impl_->file_->writeLine("local IFS=$'\\n'\n");
251 impl_->file_->writeLine("COMPREPLY=()");
252 impl_->file_->writeLine("unset COMP_WORDS[0]");
253 impl_->file_->writeLine("for ((i=1;i<COMP_CWORD;++i)) ; do");
254 impl_->file_->writeLine("[[ \"${COMP_WORDS[i]}\" != -* ]] && break");
255 impl_->file_->writeLine("unset COMP_WORDS[i]");
256 impl_->file_->writeLine("done");
257 impl_->file_->writeLine("if (( i == COMP_CWORD )); then");
258 impl_->file_->writeLine("c=${COMP_WORDS[COMP_CWORD]}");
259 OptionsListWriter lister;
260 lister.visitSubSection(options);
261 std::string completions(lister.optionList());
262 for (ModuleNameList::const_iterator i = modules.begin();
263 i != modules.end(); ++i)
265 completions.append("\\n");
266 completions.append(*i);
268 impl_->file_->writeLine("COMPREPLY=( $(compgen -S ' ' -W $'" + completions + "' -- $c) )");
269 impl_->file_->writeLine("return 0");
270 impl_->file_->writeLine("fi");
271 impl_->file_->writeLine("m=${COMP_WORDS[i]}");
272 impl_->file_->writeLine("COMP_WORDS=( \"${COMP_WORDS[@]}\" )");
273 impl_->file_->writeLine("COMP_CWORD=$((COMP_CWORD-i))");
274 impl_->file_->writeLine("case \"$m\" in");
275 for (ModuleNameList::const_iterator i = modules.begin();
276 i != modules.end(); ++i)
278 const char *const name = i->c_str();
279 impl_->file_->writeLine(formatString("%s) %s ;;", name,
280 impl_->completionFunctionName(name).c_str()));
282 impl_->file_->writeLine("esac }");
285 void ShellCompletionWriter::finishCompletions()
287 impl_->file_->close();
288 impl_->file_.reset();