src/gromacs/commandline/shellcompletions.cpp

   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  * Implements gmx::ShellCompletionWriter.
  40  *
  41  * \author Teemu Murtola <teemu.murtola@gmail.com>
  42  * \ingroup module_commandline
  43  */
  44 #include "gmxpre.h"
  45
  46 #include "shellcompletions.h"
  47
  48 #include <cstdio>
  49
  50 #include <string>
  51
  52 #include <boost/scoped_ptr.hpp>
  53
  54 #include "gromacs/commandline/cmdlinehelpcontext.h"
  55 #include "gromacs/commandline/pargs.h"
  56 #include "gromacs/fileio/filenm.h"
  57 #include "gromacs/options/basicoptions.h"
  58 #include "gromacs/options/filenameoption.h"
  59 #include "gromacs/options/optionsvisitor.h"
  60 #include "gromacs/utility/arrayref.h"
  61 #include "gromacs/utility/exceptions.h"
  62 #include "gromacs/utility/file.h"
  63 #include "gromacs/utility/gmxassert.h"
  64 #include "gromacs/utility/stringutil.h"
  65
  66 namespace gmx
  67 {
  68
  69 namespace
  70 {
  71
  72 class OptionsListWriter : public OptionsVisitor
  73 {
  74     public:
  75         const std::string &optionList() const { return optionList_; }
  76
  77         virtual void visitSubSection(const Options &section)
  78         {
  79             OptionsIterator iterator(section);
  80             iterator.acceptSubSections(this);
  81             iterator.acceptOptions(this);
  82         }
  83         virtual void visitOption(const OptionInfo &option)
  84         {
  85             if (option.isHidden())
  86             {
  87                 return;
  88             }
  89             if (!optionList_.empty())
  90             {
  91                 optionList_.append("\\n");
  92             }
  93             optionList_.append("-");
  94             const BooleanOptionInfo *booleanOption
  95                 = option.toType<BooleanOptionInfo>();
  96             if (booleanOption != NULL && booleanOption->defaultValue())
  97             {
  98                 optionList_.append("no");
  99             }
 100             optionList_.append(option.name());
 101         }
 102
 103     private:
 104         std::string optionList_;
 105 };
 106
 107 class OptionCompletionWriter : public OptionsVisitor
 108 {
 109     public:
 110         explicit OptionCompletionWriter(File *out) : out_(*out) {}
 111
 112         virtual void visitSubSection(const Options &section)
 113         {
 114             OptionsIterator iterator(section);
 115             iterator.acceptSubSections(this);
 116             iterator.acceptOptions(this);
 117         }
 118         virtual void visitOption(const OptionInfo &option);
 119
 120     private:
 121         void writeOptionCompletion(const OptionInfo  &option,
 122                                    const std::string &completion);
 123
 124         File &out_;
 125 };
 126
 127 void OptionCompletionWriter::visitOption(const OptionInfo &option)
 128 {
 129     if (option.isHidden())
 130     {
 131         return;
 132     }
 133     const FileNameOptionInfo *fileOption = option.toType<FileNameOptionInfo>();
 134     if (fileOption != NULL)
 135     {
 136         if (fileOption->isDirectoryOption())
 137         {
 138             writeOptionCompletion(option, "compgen -S ' ' -d $c");
 139             return;
 140         }
 141         const FileNameOptionInfo::ExtensionList &extensionList = fileOption->extensions();
 142         if (extensionList.empty())
 143         {
 144             return;
 145         }
 146         std::string completion("compgen -S ' ' -X '!*");
 147         std::string extensions(joinStrings(extensionList, "|"));
 148         if (extensionList.size() > 1)
 149         {
 150             extensions = "@(" + extensions + ")";
 151         }
 152         completion.append(extensions);
 153         // TODO: Don't duplicate this from filenm.c/futil.c.
 154         completion.append("?(.gz|.Z)' -f -- $c ; compgen -S '/' -d $c");
 155         writeOptionCompletion(option, completion);
 156         return;
 157     }
 158     const StringOptionInfo *stringOption = option.toType<StringOptionInfo>();
 159     if (stringOption != NULL && stringOption->isEnumerated())
 160     {
 161         std::string completion("compgen -S ' ' -W $'");
 162         completion.append(joinStrings(stringOption->allowedValues(), "\\n"));
 163         completion.append("' -- $c");
 164         writeOptionCompletion(option, completion);
 165         return;
 166     }
 167 }
 168
 169 void OptionCompletionWriter::writeOptionCompletion(
 170         const OptionInfo &option, const std::string &completion)
 171 {
 172     std::string result(formatString("-%s) ", option.name().c_str()));
 173     if (option.maxValueCount() >= 0)
 174     {
 175         result.append(formatString("(( $n <= %d )) && ", option.maxValueCount()));
 176     }
 177     result.append("COMPREPLY=( $(");
 178     result.append(completion);
 179     result.append("));;");
 180     out_.writeLine(result);
 181 }
 182
 183 }   // namespace
 184
 185 class ShellCompletionWriter::Impl
 186 {
 187     public:
 188         Impl(const std::string &binaryName, ShellCompletionFormat /*format*/)
 189             : binaryName_(binaryName)
 190         {
 191         }
 192
 193         std::string completionFunctionName(const char *moduleName) const
 194         {
 195             // TODO: Consider if some characters need to be escaped.
 196             return formatString("_%s_%s_compl", binaryName_.c_str(), moduleName);
 197         }
 198
 199         std::string             binaryName_;
 200         boost::scoped_ptr<File> file_;
 201 };
 202
 203 ShellCompletionWriter::ShellCompletionWriter(const std::string     &binaryName,
 204                                              ShellCompletionFormat  format)
 205     : impl_(new Impl(binaryName, format))
 206 {
 207 }
 208
 209 ShellCompletionWriter::~ShellCompletionWriter()
 210 {
 211 }
 212
 213 File *ShellCompletionWriter::outputFile()
 214 {
 215     return impl_->file_.get();
 216 }
 217
 218 void ShellCompletionWriter::startCompletions()
 219 {
 220     impl_->file_.reset(new File(impl_->binaryName_ + "-completion.bash", "w"));
 221     impl_->file_->writeLine("shopt -s extglob");
 222 }
 223
 224 void ShellCompletionWriter::writeModuleCompletions(
 225         const char    *moduleName,
 226         const Options &options)
 227 {
 228     File &out = *impl_->file_;
 229     out.writeLine(formatString("%s() {", impl_->completionFunctionName(moduleName).c_str()));
 230     out.writeLine("local IFS=$'\\n'");
 231     out.writeLine("local c=${COMP_WORDS[COMP_CWORD]}");
 232     out.writeLine("local n");
 233     out.writeLine("for ((n=1;n<COMP_CWORD;++n)) ; do [[ \"${COMP_WORDS[COMP_CWORD-n]}\" == -* ]] && break ; done");
 234     out.writeLine("local p=${COMP_WORDS[COMP_CWORD-n]}");
 235     out.writeLine("COMPREPLY=()");
 236
 237     OptionsListWriter listWriter;
 238     listWriter.visitSubSection(options);
 239     out.writeLine(formatString("if (( $COMP_CWORD <= 1 )) || [[ $c == -* ]]; then COMPREPLY=( $(compgen -S ' '  -W $'%s' -- $c)); return 0; fi", listWriter.optionList().c_str()));
 240
 241     out.writeLine("case \"$p\" in");
 242     OptionCompletionWriter optionWriter(&out);
 243     optionWriter.visitSubSection(options);
 244     out.writeLine("esac }");
 245 }
 246
 247 void ShellCompletionWriter::writeWrapperCompletions(
 248         const ModuleNameList &modules, const Options &options)
 249 {
 250     impl_->file_->writeLine("_" + impl_->binaryName_ + "_compl() {");
 251     impl_->file_->writeLine("local i c m");
 252     impl_->file_->writeLine("local IFS=$'\\n'\n");
 253     impl_->file_->writeLine("COMPREPLY=()");
 254     impl_->file_->writeLine("unset COMP_WORDS[0]");
 255     impl_->file_->writeLine("for ((i=1;i<COMP_CWORD;++i)) ; do");
 256     impl_->file_->writeLine("[[ \"${COMP_WORDS[i]}\" != -* ]] && break");
 257     impl_->file_->writeLine("unset COMP_WORDS[i]");
 258     impl_->file_->writeLine("done");
 259     impl_->file_->writeLine("if (( i == COMP_CWORD )); then");
 260     impl_->file_->writeLine("c=${COMP_WORDS[COMP_CWORD]}");
 261     OptionsListWriter lister;
 262     lister.visitSubSection(options);
 263     std::string       completions(lister.optionList());
 264     for (ModuleNameList::const_iterator i = modules.begin();
 265          i != modules.end(); ++i)
 266     {
 267         completions.append("\\n");
 268         completions.append(*i);
 269     }
 270     impl_->file_->writeLine("COMPREPLY=( $(compgen -S ' ' -W $'" + completions + "' -- $c) )");
 271     impl_->file_->writeLine("return 0");
 272     impl_->file_->writeLine("fi");
 273     impl_->file_->writeLine("m=${COMP_WORDS[i]}");
 274     impl_->file_->writeLine("COMP_WORDS=( \"${COMP_WORDS[@]}\" )");
 275     impl_->file_->writeLine("COMP_CWORD=$((COMP_CWORD-i))");
 276     impl_->file_->writeLine("case \"$m\" in");
 277     for (ModuleNameList::const_iterator i = modules.begin();
 278          i != modules.end(); ++i)
 279     {
 280         const char *const name = i->c_str();
 281         impl_->file_->writeLine(formatString("%s) %s ;;", name,
 282                                              impl_->completionFunctionName(name).c_str()));
 283     }
 284     impl_->file_->writeLine("esac }");
 285 }
 286
 287 void ShellCompletionWriter::finishCompletions()
 288 {
 289     impl_->file_->close();
 290     impl_->file_.reset();
 291 }
 292
 293 } // namespace gmx