2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
37 * Implements gmx::CommandLineHelpModule.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_commandline
44 #include "cmdlinehelpmodule.h"
49 #include <boost/scoped_ptr.hpp>
51 #include "gromacs/commandline/cmdlinehelpcontext.h"
52 #include "gromacs/commandline/cmdlinehelpwriter.h"
53 #include "gromacs/commandline/cmdlineparser.h"
54 #include "gromacs/onlinehelp/helpformat.h"
55 #include "gromacs/onlinehelp/helpmanager.h"
56 #include "gromacs/onlinehelp/helptopic.h"
57 #include "gromacs/onlinehelp/helpwritercontext.h"
58 #include "gromacs/options/basicoptions.h"
59 #include "gromacs/options/options.h"
60 #include "gromacs/utility/baseversion.h"
61 #include "gromacs/utility/exceptions.h"
62 #include "gromacs/utility/file.h"
63 #include "gromacs/utility/gmxassert.h"
64 #include "gromacs/utility/programcontext.h"
65 #include "gromacs/utility/stringutil.h"
67 #include "shellcompletions.h"
74 class HelpExportInterface;
78 /********************************************************************
79 * CommandLineHelpModuleImpl declaration
82 class CommandLineHelpModuleImpl
85 CommandLineHelpModuleImpl(const ProgramContextInterface &programContext,
86 const std::string &binaryName,
87 const CommandLineModuleMap &modules,
88 const CommandLineModuleGroupList &groups);
90 void exportHelp(HelpExportInterface *exporter) const;
92 boost::scoped_ptr<RootHelpTopic> rootTopic_;
93 const ProgramContextInterface &programContext_;
94 std::string binaryName_;
95 const CommandLineModuleMap &modules_;
96 const CommandLineModuleGroupList &groups_;
98 CommandLineHelpContext *context_;
99 const CommandLineModuleInterface *moduleOverride_;
102 File *outputOverride_;
104 GMX_DISALLOW_COPY_AND_ASSIGN(CommandLineHelpModuleImpl);
110 /********************************************************************
116 static const char name[];
117 static const char title[];
118 static const char *const text[];
121 // The first two are not used.
122 const char RootHelpText::name[] = "";
123 const char RootHelpText::title[] = "";
124 const char *const RootHelpText::text[] = { "" };
127 * Help topic that forms the root of the help tree for the help subcommand.
129 * \ingroup module_commandline
131 class RootHelpTopic : public CompositeHelpTopic<RootHelpText>
135 * Creates a root help topic.
139 explicit RootHelpTopic(const CommandLineHelpModuleImpl &helpModule)
140 : helpModule_(helpModule)
144 virtual void writeHelp(const HelpWriterContext &context) const;
147 const CommandLineHelpModuleImpl &helpModule_;
149 GMX_DISALLOW_COPY_AND_ASSIGN(RootHelpTopic);
152 void RootHelpTopic::writeHelp(const HelpWriterContext &context) const
154 if (context.outputFormat() != eHelpOutputFormat_Console)
156 // TODO: Implement once the situation with Redmine issue #969 is more
158 GMX_THROW(NotImplementedError(
159 "Root help is not implemented for this output format"));
162 CommandLineCommonOptionsHolder optionsHolder;
163 CommandLineHelpContext cmdlineContext(*helpModule_.context_);
164 cmdlineContext.setModuleDisplayName(helpModule_.binaryName_);
165 optionsHolder.initOptions();
166 // TODO: Add <command> [<args>] into the synopsis.
167 CommandLineHelpWriter(*optionsHolder.options())
168 .writeHelp(cmdlineContext);
170 // TODO: Consider printing a list of "core" commands. Would require someone
171 // to determine such a set...
172 writeSubTopicList(context,
173 "Additional help is available on the following topics:");
174 context.writeTextBlock(
175 "To access the help, use '[PROGRAM] help <topic>'.[BR]"
176 "For help on a command, use '[PROGRAM] help <command>'.");
179 /********************************************************************
184 * Help topic for listing the commands.
186 * \ingroup module_commandline
188 class CommandsHelpTopic : public HelpTopicInterface
192 * Creates a command list help topic.
194 * \param[in] helpModule Help module to get module information from.
198 explicit CommandsHelpTopic(const CommandLineHelpModuleImpl &helpModule)
199 : helpModule_(helpModule)
203 virtual const char *name() const { return "commands"; }
204 virtual const char *title() const { return "List of available commands"; }
205 virtual bool hasSubTopics() const { return false; }
206 virtual const HelpTopicInterface *findSubTopic(const char * /*name*/) const
211 virtual void writeHelp(const HelpWriterContext &context) const;
214 const CommandLineHelpModuleImpl &helpModule_;
216 GMX_DISALLOW_COPY_AND_ASSIGN(CommandsHelpTopic);
219 void CommandsHelpTopic::writeHelp(const HelpWriterContext &context) const
221 if (context.outputFormat() != eHelpOutputFormat_Console)
223 GMX_THROW(NotImplementedError(
224 "Module list is not implemented for this output format"));
226 int maxNameLength = 0;
227 const CommandLineModuleMap &modules = helpModule_.modules_;
228 CommandLineModuleMap::const_iterator module;
229 for (module = modules.begin(); module != modules.end(); ++module)
231 int nameLength = static_cast<int>(module->first.length());
232 if (module->second->shortDescription() != NULL
233 && nameLength > maxNameLength)
235 maxNameLength = nameLength;
238 context.writeTextBlock(
239 "Usage: [PROGRAM] [<options>] <command> [<args>][PAR]"
240 "Available commands:");
241 File &file = context.outputFile();
242 TextTableFormatter formatter;
243 formatter.addColumn(NULL, maxNameLength + 1, false);
244 formatter.addColumn(NULL, 72 - maxNameLength, true);
245 formatter.setFirstColumnIndent(4);
246 for (module = modules.begin(); module != modules.end(); ++module)
248 const char *name = module->first.c_str();
249 const char *description = module->second->shortDescription();
250 if (description != NULL)
253 formatter.addColumnLine(0, name);
254 formatter.addColumnLine(1, description);
255 file.writeString(formatter.formatRow());
258 context.writeTextBlock(
259 "For help on a command, use '[PROGRAM] help <command>'.");
262 /********************************************************************
267 * Help topic wrapper for a command-line module.
269 * This class implements HelpTopicInterface such that it wraps a
270 * CommandLineModuleInterface, allowing subcommand "help <command>"
271 * to produce the help for "<command>".
273 * \ingroup module_commandline
275 class ModuleHelpTopic : public HelpTopicInterface
278 //! Constructs a help topic for a specific module.
279 ModuleHelpTopic(const CommandLineModuleInterface &module,
280 const CommandLineHelpModuleImpl &helpModule)
281 : module_(module), helpModule_(helpModule)
285 virtual const char *name() const { return module_.name(); }
286 virtual const char *title() const { return NULL; }
287 virtual bool hasSubTopics() const { return false; }
288 virtual const HelpTopicInterface *findSubTopic(const char * /*name*/) const
292 virtual void writeHelp(const HelpWriterContext &context) const;
295 const CommandLineModuleInterface &module_;
296 const CommandLineHelpModuleImpl &helpModule_;
298 GMX_DISALLOW_COPY_AND_ASSIGN(ModuleHelpTopic);
301 void ModuleHelpTopic::writeHelp(const HelpWriterContext & /*context*/) const
303 CommandLineHelpContext context(*helpModule_.context_);
304 const char *const program = helpModule_.binaryName_.c_str();
305 context.setModuleDisplayName(formatString("%s %s", program, module_.name()));
306 module_.writeHelp(context);
309 /********************************************************************
310 * HelpExportInterface
314 * Callbacks for exporting help information for command-line modules.
316 * \ingroup module_commandline
318 class HelpExportInterface
321 //! Shorthand for a list of modules contained in a group.
322 typedef CommandLineModuleGroupData::ModuleList ModuleGroupContents;
324 virtual ~HelpExportInterface() {};
327 * Called once before exporting individual modules.
329 * Can, e.g., open shared output files (e.g., if the output is written
330 * into a single file, or if a separate index is required) and write
333 virtual void startModuleExport() = 0;
335 * Called to export the help for each module.
337 * \param[in] module Module for which the help should be exported.
338 * \param[in] tag Unique tag for the module (gmx-something).
339 * \param[in] displayName Display name for the module (gmx something).
341 virtual void exportModuleHelp(
342 const CommandLineModuleInterface &module,
343 const std::string &tag,
344 const std::string &displayName) = 0;
346 * Called after all modules have been exported.
348 * Can close files opened in startModuleExport(), write footers to them
351 virtual void finishModuleExport() = 0;
354 * Called once before exporting module groups.
356 * Can, e.g., open a single output file for listing all the groups.
358 virtual void startModuleGroupExport() = 0;
360 * Called to export the help for each module group.
362 * \param[in] title Title for the group.
363 * \param[in] modules List of modules in the group.
365 virtual void exportModuleGroup(const char *title,
366 const ModuleGroupContents &modules) = 0;
368 * Called after all module groups have been exported.
370 * Can close files opened in startModuleGroupExport(), write footers to them
373 virtual void finishModuleGroupExport() = 0;
377 * Adds hyperlinks to modules within this binary.
379 * \param[in,out] links Links are added here.
380 * \param[in] helpModule Help module to get module information from.
381 * \throws std::bad_alloc if out of memory.
383 * Initializes a HelpLinks object with links to modules defined in
386 * \ingroup module_commandline
388 void initProgramLinks(HelpLinks *links, const CommandLineHelpModuleImpl &helpModule)
390 const char *const program = helpModule.binaryName_.c_str();
391 CommandLineModuleMap::const_iterator module;
392 for (module = helpModule.modules_.begin();
393 module != helpModule.modules_.end();
396 if (module->second->shortDescription() != NULL)
398 std::string linkName("[gmx-" + module->first + "]");
399 const char *name = module->first.c_str();
400 std::string reference(
401 formatString(":doc:`%s %s <%s-%s>`", program, name, program, name));
402 std::string displayName(
403 formatString("[TT]%s %s[tt]", program, name));
404 links->addLink(linkName, reference, displayName);
409 /********************************************************************
410 * HelpExportReStructuredText
414 * Implements export for web pages as reStructuredText.
416 * \ingroup module_commandline
418 class HelpExportReStructuredText : public HelpExportInterface
421 //! Initializes reST exporter.
422 explicit HelpExportReStructuredText(
423 const CommandLineHelpModuleImpl &helpModule);
425 virtual void startModuleExport();
426 virtual void exportModuleHelp(
427 const CommandLineModuleInterface &module,
428 const std::string &tag,
429 const std::string &displayName);
430 virtual void finishModuleExport();
432 virtual void startModuleGroupExport();
433 virtual void exportModuleGroup(const char *title,
434 const ModuleGroupContents &modules);
435 virtual void finishModuleGroupExport();
439 boost::scoped_ptr<File> indexFile_;
440 boost::scoped_ptr<File> manPagesFile_;
443 HelpExportReStructuredText::HelpExportReStructuredText(
444 const CommandLineHelpModuleImpl &helpModule)
445 : links_(eHelpOutputFormat_Rst)
447 File linksFile("links.dat", "r");
449 while (linksFile.readLine(&line))
451 links_.addLink("[REF]." + line + "[ref]",
452 formatString(":ref:`.%s <%s>`", line.c_str(), line.c_str()),
454 links_.addLink("[REF]" + line + "[ref]", formatString(":ref:`%s`", line.c_str()), line);
457 initProgramLinks(&links_, helpModule);
460 void HelpExportReStructuredText::startModuleExport()
462 indexFile_.reset(new File("programs/byname.rst", "w"));
463 indexFile_->writeLine("Tools by Name");
464 indexFile_->writeLine("=============");
465 manPagesFile_.reset(new File("conf-man.py", "w"));
466 manPagesFile_->writeLine("man_pages = [");
469 void HelpExportReStructuredText::exportModuleHelp(
470 const CommandLineModuleInterface &module,
471 const std::string &tag,
472 const std::string &displayName)
474 // TODO: Ideally, the file would only be touched if it really changes.
475 // This would make Sphinx reruns much faster.
476 File file("programs/" + tag + ".rst", "w");
477 file.writeLine(formatString(".. _%s:", displayName.c_str()));
479 file.writeLine(displayName);
480 file.writeLine(std::string(displayName.length(), '='));
481 CommandLineHelpContext context(&file, eHelpOutputFormat_Rst, &links_);
482 context.setModuleDisplayName(displayName);
483 module.writeHelp(context);
486 file.writeLine(".. only:: man");
488 file.writeLine(" See also");
489 file.writeLine(" --------");
491 file.writeLine(" :manpage:`gromacs(7)`");
493 file.writeLine(" More information about |Gromacs| is available at <http://www.gromacs.org/>.");
496 indexFile_->writeLine(formatString("* :doc:`%s <%s>` - %s",
497 displayName.c_str(), tag.c_str(),
498 module.shortDescription()));
499 manPagesFile_->writeLine(
500 formatString(" ('programs/%s', '%s', \"%s\", '', 1),",
501 tag.c_str(), tag.c_str(), module.shortDescription()));
504 void HelpExportReStructuredText::finishModuleExport()
508 manPagesFile_->writeLine(" ('man/gromacs.7', 'gromacs', 'molecular dynamics simulation suite', '', 7)");
509 manPagesFile_->writeLine("]");
510 manPagesFile_->close();
511 manPagesFile_.reset();
514 void HelpExportReStructuredText::startModuleGroupExport()
516 indexFile_.reset(new File("programs/bytopic.rst", "w"));
517 indexFile_->writeLine("Tools by Topic");
518 indexFile_->writeLine("==============");
519 manPagesFile_.reset(new File("man/bytopic.rst", "w"));
522 void HelpExportReStructuredText::exportModuleGroup(
524 const ModuleGroupContents &modules)
526 indexFile_->writeLine(title);
527 indexFile_->writeLine(std::string(std::strlen(title), '-'));
528 manPagesFile_->writeLine(title);
529 manPagesFile_->writeLine(std::string(std::strlen(title), '+'));
531 ModuleGroupContents::const_iterator module;
532 for (module = modules.begin(); module != modules.end(); ++module)
534 const std::string &tag(module->first);
535 std::string displayName(tag);
536 // TODO: This does not work if the binary name would contain a dash,
537 // but that is not currently the case.
538 const size_t dashPos = displayName.find('-');
539 GMX_RELEASE_ASSERT(dashPos != std::string::npos,
540 "There should always be at least one dash in the tag");
541 displayName[dashPos] = ' ';
542 indexFile_->writeLine(formatString("| :doc:`%s <%s>` - %s",
543 displayName.c_str(), tag.c_str(),
545 manPagesFile_->writeLine(formatString("| ``%s`` - %s",
549 indexFile_->writeLine();
550 manPagesFile_->writeLine();
553 void HelpExportReStructuredText::finishModuleGroupExport()
557 manPagesFile_->close();
558 manPagesFile_.reset();
561 /********************************************************************
562 * HelpExportCompletion
566 * Implements export for command-line completion.
568 * \ingroup module_commandline
570 class HelpExportCompletion : public HelpExportInterface
573 //! Initializes completion exporter.
574 explicit HelpExportCompletion(const CommandLineHelpModuleImpl &helpModule);
576 virtual void startModuleExport();
577 virtual void exportModuleHelp(
578 const CommandLineModuleInterface &module,
579 const std::string &tag,
580 const std::string &displayName);
581 virtual void finishModuleExport();
583 virtual void startModuleGroupExport() {}
584 virtual void exportModuleGroup(const char * /*title*/,
585 const ModuleGroupContents & /*modules*/) {}
586 virtual void finishModuleGroupExport() {}
589 ShellCompletionWriter bashWriter_;
590 std::vector<std::string> modules_;
593 HelpExportCompletion::HelpExportCompletion(
594 const CommandLineHelpModuleImpl &helpModule)
595 : bashWriter_(helpModule.binaryName_, eShellCompletionFormat_Bash)
599 void HelpExportCompletion::startModuleExport()
601 bashWriter_.startCompletions();
604 void HelpExportCompletion::exportModuleHelp(
605 const CommandLineModuleInterface &module,
606 const std::string & /*tag*/,
607 const std::string & /*displayName*/)
609 modules_.push_back(module.name());
611 CommandLineHelpContext context(&bashWriter_);
612 // We use the display name to pass the name of the module to the
613 // completion writer.
614 context.setModuleDisplayName(module.name());
615 module.writeHelp(context);
619 void HelpExportCompletion::finishModuleExport()
621 CommandLineCommonOptionsHolder optionsHolder;
622 optionsHolder.initOptions();
623 bashWriter_.writeWrapperCompletions(modules_, *optionsHolder.options());
624 bashWriter_.finishCompletions();
629 /********************************************************************
630 * CommandLineHelpModuleImpl implementation
632 CommandLineHelpModuleImpl::CommandLineHelpModuleImpl(
633 const ProgramContextInterface &programContext,
634 const std::string &binaryName,
635 const CommandLineModuleMap &modules,
636 const CommandLineModuleGroupList &groups)
637 : rootTopic_(new RootHelpTopic(*this)), programContext_(programContext),
638 binaryName_(binaryName), modules_(modules), groups_(groups),
639 context_(NULL), moduleOverride_(NULL), bHidden_(false),
640 outputOverride_(NULL)
644 void CommandLineHelpModuleImpl::exportHelp(HelpExportInterface *exporter) const
646 // TODO: Would be nicer to have the file names supplied by the build system
647 // and/or export a list of files from here.
648 const char *const program = binaryName_.c_str();
650 exporter->startModuleExport();
651 CommandLineModuleMap::const_iterator module;
652 for (module = modules_.begin(); module != modules_.end(); ++module)
654 if (module->second->shortDescription() != NULL)
656 const char *const moduleName = module->first.c_str();
657 std::string tag(formatString("%s-%s", program, moduleName));
658 std::string displayName(formatString("%s %s", program, moduleName));
659 exporter->exportModuleHelp(*module->second, tag, displayName);
662 exporter->finishModuleExport();
664 exporter->startModuleGroupExport();
665 CommandLineModuleGroupList::const_iterator group;
666 for (group = groups_.begin(); group != groups_.end(); ++group)
668 exporter->exportModuleGroup((*group)->title(), (*group)->modules());
670 exporter->finishModuleGroupExport();
673 /********************************************************************
674 * CommandLineHelpModule
677 CommandLineHelpModule::CommandLineHelpModule(
678 const ProgramContextInterface &programContext,
679 const std::string &binaryName,
680 const CommandLineModuleMap &modules,
681 const CommandLineModuleGroupList &groups)
682 : impl_(new Impl(programContext, binaryName, modules, groups))
686 CommandLineHelpModule::~CommandLineHelpModule()
690 HelpTopicPointer CommandLineHelpModule::createModuleHelpTopic(
691 const CommandLineModuleInterface &module) const
693 return HelpTopicPointer(new ModuleHelpTopic(module, *impl_));
696 void CommandLineHelpModule::addTopic(HelpTopicPointer topic)
698 impl_->rootTopic_->addSubTopic(move(topic));
701 void CommandLineHelpModule::setShowHidden(bool bHidden)
703 impl_->bHidden_ = bHidden;
706 void CommandLineHelpModule::setModuleOverride(
707 const CommandLineModuleInterface &module)
709 impl_->moduleOverride_ = &module;
712 void CommandLineHelpModule::setOutputRedirect(File *output)
714 impl_->outputOverride_ = output;
717 int CommandLineHelpModule::run(int argc, char *argv[])
719 // Add internal topics lazily here.
720 addTopic(HelpTopicPointer(new CommandsHelpTopic(*impl_)));
722 const char *const exportFormats[] = { "rst", "completion" };
723 std::string exportFormat;
724 Options options(NULL, NULL);
725 options.addOption(StringOption("export").store(&exportFormat)
726 .enumValue(exportFormats));
727 CommandLineParser(&options).parse(&argc, argv);
728 if (!exportFormat.empty())
730 boost::scoped_ptr<HelpExportInterface> exporter;
731 if (exportFormat == "rst")
733 exporter.reset(new HelpExportReStructuredText(*impl_));
735 else if (exportFormat == "completion")
737 exporter.reset(new HelpExportCompletion(*impl_));
741 GMX_THROW(NotImplementedError("This help format is not implemented"));
743 impl_->exportHelp(exporter.get());
747 File *outputFile = &File::standardOutput();
748 if (impl_->outputOverride_ != NULL)
750 outputFile = impl_->outputOverride_;
752 HelpLinks links(eHelpOutputFormat_Console);
753 initProgramLinks(&links, *impl_);
754 boost::scoped_ptr<CommandLineHelpContext> context(
755 new CommandLineHelpContext(outputFile,
756 eHelpOutputFormat_Console, &links));
757 context->setShowHidden(impl_->bHidden_);
758 if (impl_->moduleOverride_ != NULL)
760 context->setModuleDisplayName(impl_->programContext_.displayName());
761 impl_->moduleOverride_->writeHelp(*context);
764 impl_->context_ = context.get();
766 HelpManager helpManager(*impl_->rootTopic_, context->writerContext());
769 for (int i = 1; i < argc; ++i)
771 helpManager.enterTopic(argv[i]);
774 catch (const InvalidInputError &ex)
776 fprintf(stderr, "%s\n", ex.what());
779 helpManager.writeCurrentTopic();
783 void CommandLineHelpModule::writeHelp(const CommandLineHelpContext &context) const
785 const HelpWriterContext &writerContext = context.writerContext();
787 if (writerContext.outputFormat() != eHelpOutputFormat_Console)
791 writerContext.writeTextBlock(
792 "Usage: [PROGRAM] help [<command>|<topic> [<subtopic> [...]]]");
793 // TODO: More information.