0b707c8b2793b01c750a9126e2e78ef295b39362
[alexxy/gromacs.git] / src / gromacs / selection / selhelp.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2009,2010,2011,2012,2013,2014, 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.
8  *
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.
13  *
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.
18  *
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.
23  *
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.
31  *
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.
34  */
35 /*! \internal \file
36  * \brief
37  * Implements functions in selhelp.h.
38  *
39  * \author Teemu Murtola <teemu.murtola@gmail.com>
40  * \ingroup module_selection
41  */
42 #include "gmxpre.h"
43
44 #include <string>
45 #include <vector>
46 #include <utility>
47
48 #include <boost/scoped_ptr.hpp>
49
50 #include "gromacs/onlinehelp/helptopic.h"
51 #include "gromacs/onlinehelp/helpwritercontext.h"
52 #include "gromacs/utility/exceptions.h"
53 #include "gromacs/utility/file.h"
54 #include "gromacs/utility/stringutil.h"
55
56 #include "selhelp.h"
57 #include "selmethod.h"
58 #include "symrec.h"
59
60 namespace
61 {
62
63 struct CommonHelpText
64 {
65     static const char        name[];
66     static const char        title[];
67     static const char *const text[];
68 };
69
70 const char        CommonHelpText::name[]  = "selections";
71 const char        CommonHelpText::title[] =
72     "Selection syntax and usage";
73 const char *const CommonHelpText::text[] = {
74     "Selections are used to select atoms/molecules/residues for analysis.",
75     "In contrast to traditional index files, selections can be dynamic, i.e.,",
76     "select different atoms for different trajectory frames.[PAR]",
77
78     "Each analysis tool requires a different number of selections and the",
79     "selections are interpreted differently. The general idea is still the",
80     "same: each selection evaluates to a set of positions, where a position",
81     "can be an atom position or center-of-mass or center-of-geometry of",
82     "a set of atoms. The tool then uses these positions for its analysis to",
83     "allow very flexible processing. Some analysis tools may have limitations",
84     "on the types of selections allowed.[PAR]",
85
86     "To get started with selections, run, e.g., [TT][PROGRAM] select[tt]",
87     "without specifying selections on the command-line and use the interactive",
88     "prompt to try out different selections.",
89     "This tool provides output options that allow one to see what is actually",
90     "selected by the given selections, and the interactive prompt reports",
91     "syntax errors immediately, allowing one to try again.",
92     "The subtopics listed below give more details on different aspects of",
93     "selections.",
94 };
95
96 struct ArithmeticHelpText
97 {
98     static const char        name[];
99     static const char        title[];
100     static const char *const text[];
101 };
102
103 const char        ArithmeticHelpText::name[]  = "arithmetic";
104 const char        ArithmeticHelpText::title[] =
105     "Arithmetic expressions in selections";
106 const char *const ArithmeticHelpText::text[] = {
107     "Basic arithmetic evaluation is supported for numeric expressions.",
108     "Supported operations are addition, subtraction, negation, multiplication,",
109     "division, and exponentiation (using ^).",
110     "Result of a division by zero or other illegal operations is undefined.",
111 };
112
113 struct CmdLineHelpText
114 {
115     static const char        name[];
116     static const char        title[];
117     static const char *const text[];
118 };
119
120 const char        CmdLineHelpText::name[]  = "cmdline";
121 const char        CmdLineHelpText::title[] =
122     "Specifying selections from command line";
123 const char *const CmdLineHelpText::text[] = {
124     "If no selections are provided on the command line, you are prompted to",
125     "type the selections interactively (a pipe can also be used to provide",
126     "the selections in this case for most tools). While this works well for",
127     "testing, it is easier to provide the selections from the command line",
128     "if they are complex or for scripting.[PAR]",
129
130     "Each tool has different command-line arguments for specifying selections",
131     "(listed by [TT][PROGRAM] help <tool>[tt]).",
132     "You can either pass a single string containing all selections (separated",
133     "by semicolons), or multiple strings, each containing one selection.",
134     "Note that you need to quote the selections to protect them from the",
135     "shell.[PAR]",
136
137     "If you set a selection command-line argument, but do not provide any",
138     "selections, you are prompted to type the selections for that argument",
139     "interactively. This is useful if that selection argument is optional,",
140     "in which case it is not normally prompted for.[PAR]",
141
142     "To provide selections from a file, use [TT]-sf file.dat[tt] in the place",
143     "of the selection for a selection argument (e.g.,",
144     "[TT]-select -sf file.dat[tt]). In general, the [TT]-sf[tt] argument reads",
145     "selections from the provided file and assigns them to selection arguments",
146     "that have been specified up to that point, but for which no selections",
147     "have been provided.",
148     "As a special case, [TT]-sf[tt] provided on its own, without preceding",
149     "selection arguments, assigns the selections to all (yet unset) required",
150     "selections (i.e., those that would be promted interactively if no",
151     "selections are provided on the command line).[PAR]",
152
153     "To use groups from a traditional index file, use argument [TT]-n[tt]",
154     "to provide a file. See the \"syntax\" subtopic for how to use them.",
155     "If this option is not provided, default groups are generated.",
156     "The default groups are generated by reading selections from a file",
157     "[TT]defselection.dat[tt]. If such a file is found in the current",
158     "directory, it is used instead of the one provided by default.[PAR]",
159
160     "Depending on the tool, two additional command-line arguments may be",
161     "available to control the behavior:[BR]",
162     "1. [TT]-seltype[tt] can be used to specify the default type of",
163     "positions to calculate for each selection.[BR]",
164     "2. [TT]-selrpos[tt] can be used to specify the default type of",
165     "positions used in selecting atoms by coordinates.[BR]",
166     "See the \"positions\" subtopic for more information on these options.",
167 };
168
169 struct EvaluationHelpText
170 {
171     static const char        name[];
172     static const char        title[];
173     static const char *const text[];
174 };
175
176 const char        EvaluationHelpText::name[]  = "evaluation";
177 const char        EvaluationHelpText::title[] =
178     "Selection evaluation and optimization";
179 const char *const EvaluationHelpText::text[] = {
180     "Boolean evaluation proceeds from left to right and is short-circuiting",
181     "i.e., as soon as it is known whether an atom will be selected, the",
182     "remaining expressions are not evaluated at all.",
183     "This can be used to optimize the selections: you should write the",
184     "most restrictive and/or the most inexpensive expressions first in",
185     "boolean expressions.",
186     "The relative ordering between dynamic and static expressions does not",
187     "matter: all static expressions are evaluated only once, before the first",
188     "frame, and the result becomes the leftmost expression.[PAR]",
189
190     "Another point for optimization is in common subexpressions: they are not",
191     "automatically recognized, but can be manually optimized by the use of",
192     "variables. This can have a big impact on the performance of complex",
193     "selections, in particular if you define several index groups like this:",
194     "  [TT]rdist = distance from com of resnr 1 to 5;[tt][BR]",
195     "  [TT]resname RES and rdist < 2;[tt][BR]",
196     "  [TT]resname RES and rdist < 4;[tt][BR]",
197     "  [TT]resname RES and rdist < 6;[tt][BR]",
198     "Without the variable assignment, the distances would be evaluated three",
199     "times, although they are exactly the same within each selection.",
200     "Anything assigned into a variable becomes a common subexpression that",
201     "is evaluated only once during a frame.",
202     "Currently, in some cases the use of variables can actually lead to a small",
203     "performance loss because of the checks necessary to determine for which",
204     "atoms the expression has already been evaluated, but this should not be",
205     "a major problem.",
206 };
207
208 struct ExamplesHelpText
209 {
210     static const char        name[];
211     static const char        title[];
212     static const char *const text[];
213 };
214
215 const char        ExamplesHelpText::name[]  = "examples";
216 const char        ExamplesHelpText::title[] =
217     "Selection examples";
218 const char *const ExamplesHelpText::text[] = {
219     // TODO: Once there are more tools available, use examples that invoke
220     // tools and explain what the selections do in those tools.
221     "Below, examples of increasingly complex selections are given.[PAR]",
222
223     "Selection of all water oxygens:[BR]",
224     "  resname SOL and name OW",
225     "[PAR]",
226
227     "Centers of mass of residues 1 to 5 and 10:[BR]",
228     "  res_com of resnr 1 to 5 10",
229     "[PAR]",
230
231     "All atoms farther than 1 nm of a fixed position:[BR]",
232     "  not within 1 of [1.2, 3.1, 2.4]",
233     "[PAR]",
234
235     "All atoms of a residue LIG within 0.5 nm of a protein (with a custom name):[BR]",
236     "  \"Close to protein\" resname LIG and within 0.5 of group \"Protein\"",
237     "[PAR]",
238
239     "All protein residues that have at least one atom within 0.5 nm of a residue LIG:[BR]",
240     "  group \"Protein\" and same residue as within 0.5 of resname LIG",
241     "[PAR]",
242
243     "All RES residues whose COM is between 2 and 4 nm from the COM of all of them:[BR]",
244     "  rdist = res_com distance from com of resname RES[BR]",
245     "  resname RES and rdist >= 2 and rdist <= 4",
246     "[PAR]",
247
248     "Selection like C1 C2 C2 C3 C3 C4 ... C8 C9 (e.g., for g_bond):[BR]",
249     "  name \"C[1-8]\" merge name \"C[2-9]\"",
250 };
251
252 struct KeywordsHelpText
253 {
254     static const char        name[];
255     static const char        title[];
256     static const char *const text[];
257 };
258
259 const char        KeywordsHelpText::name[]  = "keywords";
260 const char        KeywordsHelpText::title[] =
261     "Selection keywords";
262 const char *const KeywordsHelpText::text[] = {
263     "The following selection keywords are currently available.",
264     "For keywords marked with a star, additional help is available through",
265     "a subtopic KEYWORD, where KEYWORD is the name of the keyword.",
266 };
267
268 struct LimitationsHelpText
269 {
270     static const char        name[];
271     static const char        title[];
272     static const char *const text[];
273 };
274
275 const char        LimitationsHelpText::name[]  = "limitations";
276 const char        LimitationsHelpText::title[] =
277     "Selection limitations";
278 const char *const LimitationsHelpText::text[] = {
279     "Some analysis programs may require a special structure for the input",
280     "selections (e.g., [TT]gmx angle[tt] requires the index group to be made",
281     "of groups of three or four atoms).",
282     "For such programs, it is up to the user to provide a proper selection",
283     "expression that always returns such positions.",
284     "[PAR]",
285
286     "Due to technical reasons, having a negative value as the first value in",
287     "expressions like[BR]",
288     "[TT]charge -1 to -0.7[tt][BR]",
289     "result in a syntax error. A workaround is to write[BR]",
290     "[TT]charge {-1 to -0.7}[tt][BR]",
291     "instead.[PAR]",
292
293     "When [TT]name[tt] selection keyword is used together with PDB input",
294     "files, the behavior may be unintuitive. When Gromacs reads in a PDB",
295     "file, 4 character atom names that start with a digit are transformed",
296     "such that, e.g., 1HG2 becomes HG21, and the latter is what is matched",
297     "by the [TT]name[tt] keyword. Use [TT]pdbname[tt] to match the atom name",
298     "as it appears in the input PDB file.",
299 };
300
301 struct PositionsHelpText
302 {
303     static const char        name[];
304     static const char        title[];
305     static const char *const text[];
306 };
307
308 const char        PositionsHelpText::name[]  = "positions";
309 const char        PositionsHelpText::title[] =
310     "Specifying positions in selections";
311 const char *const PositionsHelpText::text[] = {
312     "Possible ways of specifying positions in selections are:[PAR]",
313
314     "1. A constant position can be defined as [TT][XX, YY, ZZ][tt], where",
315     "[TT]XX[tt], [TT]YY[tt] and [TT]ZZ[tt] are real numbers.[PAR]",
316
317     "2. [TT]com of ATOM_EXPR [pbc][tt] or [TT]cog of ATOM_EXPR [pbc][tt]",
318     "calculate the center of mass/geometry of [TT]ATOM_EXPR[tt]. If",
319     "[TT]pbc[tt] is specified, the center is calculated iteratively to try",
320     "to deal with cases where [TT]ATOM_EXPR[tt] wraps around periodic",
321     "boundary conditions.[PAR]",
322
323     "3. [TT]POSTYPE of ATOM_EXPR[tt] calculates the specified positions for",
324     "the atoms in [TT]ATOM_EXPR[tt].",
325     "[TT]POSTYPE[tt] can be [TT]atom[tt], [TT]res_com[tt], [TT]res_cog[tt],",
326     "[TT]mol_com[tt] or [TT]mol_cog[tt], with an optional prefix [TT]whole_[tt]",
327     "[TT]part_[tt] or [TT]dyn_[tt].",
328     "[TT]whole_[tt] calculates the centers for the whole residue/molecule,",
329     "even if only part of it is selected.",
330     "[TT]part_[tt] prefix calculates the centers for the selected atoms, but",
331     "uses always the same atoms for the same residue/molecule. The used atoms",
332     "are determined from the the largest group allowed by the selection.",
333     "[TT]dyn_[tt] calculates the centers strictly only for the selected atoms.",
334     "If no prefix is specified, whole selections default to [TT]part_[tt] and",
335     "other places default to [TT]whole_[tt].",
336     "The latter is often desirable to select the same molecules in different",
337     "tools, while the first is a compromise between speed ([TT]dyn_[tt]",
338     "positions can be slower to evaluate than [TT]part_[tt]) and intuitive",
339     "behavior.[PAR]",
340
341     "4. [TT]ATOM_EXPR[tt], when given for whole selections, is handled as 3.",
342     "above, using the position type from the command-line argument",
343     "[TT]-seltype[tt].[PAR]",
344
345     "Selection keywords that select atoms based on their positions, such as",
346     "[TT]dist from[tt], use by default the positions defined by the",
347     "[TT]-selrpos[tt] command-line option.",
348     "This can be overridden by prepending a [TT]POSTYPE[tt] specifier to the",
349     "keyword. For example, [TT]res_com dist from POS[tt] evaluates the",
350     "residue center of mass distances. In the example, all atoms of a residue",
351     "are either selected or not, based on the single distance calculated.",
352 };
353
354 struct SyntaxHelpText
355 {
356     static const char        name[];
357     static const char        title[];
358     static const char *const text[];
359 };
360
361 const char        SyntaxHelpText::name[]  = "syntax";
362 const char        SyntaxHelpText::title[] =
363     "Selection syntax";
364 const char *const SyntaxHelpText::text[] = {
365     "A set of selections consists of one or more selections, separated by",
366     "semicolons. Each selection defines a set of positions for the analysis.",
367     "Each selection can also be preceded by a string that gives a name for",
368     "the selection for use in, e.g., graph legends.",
369     "If no name is provided, the string used for the selection is used",
370     "automatically as the name.[PAR]",
371
372     "For interactive input, the syntax is slightly altered: line breaks can",
373     "also be used to separate selections. \\ followed by a line break can",
374     "be used to continue a line if necessary.",
375     "Notice that the above only applies to real interactive input,",
376     "not if you provide the selections, e.g., from a pipe.[PAR]",
377
378     "It is possible to use variables to store selection expressions.",
379     "A variable is defined with the following syntax:[BR]",
380     "[TT]VARNAME = EXPR ;[tt][BR]",
381     "where [TT]EXPR[tt] is any valid selection expression.",
382     "After this, [TT]VARNAME[tt] can be used anywhere where [TT]EXPR[tt]",
383     "would be valid.[PAR]",
384
385     "Selections are composed of three main types of expressions, those that",
386     "define atoms ([TT]ATOM_EXPR[tt]s), those that define positions",
387     "([TT]POS_EXPR[tt]s), and those that evaluate to numeric values",
388     "([TT]NUM_EXPR[tt]s). Each selection should be a [TT]POS_EXPR[tt]",
389     "or a [TT]ATOM_EXPR[tt] (the latter is automatically converted to",
390     "positions). The basic rules are as follows:[BR]",
391     "1. An expression like [TT]NUM_EXPR1 < NUM_EXPR2[tt] evaluates to an",
392     "[TT]ATOM_EXPR[tt] that selects all the atoms for which the comparison",
393     "is true.[BR]",
394     "2. Atom expressions can be combined with boolean operations such as",
395     "[TT]not ATOM_EXPR[tt], [TT]ATOM_EXPR and ATOM_EXPR[tt], or",
396     "[TT]ATOM_EXPR or ATOM_EXPR[tt]. Parentheses can be used to alter the",
397     "evaluation order.[BR]",
398     "3. [TT]ATOM_EXPR[tt] expressions can be converted into [TT]POS_EXPR[tt]",
399     "expressions in various ways, see the \"positions\" subtopic for more",
400     "details.[PAR]",
401
402     "Some keywords select atoms based on string values such as the atom name.",
403     "For these keywords, it is possible to use wildcards ([TT]name \"C*\"[tt])",
404     "or regular expressions (e.g., [TT]resname \"R[AB]\"[tt]).",
405     "The match type is automatically guessed from the string: if it contains",
406     "other characters than letters, numbers, '*', or '?', it is interpreted",
407     "as a regular expression.",
408     "To force the matching to use literal string matching, use",
409     "[TT]name = \"C*\"[tt] to match a literal C*.",
410     "To force other type of matching, use '?' or '~' in place of '=' to force",
411     "wildcard or regular expression matching, respectively.[PAR]",
412
413     "Strings that contain non-alphanumeric characters should be enclosed in",
414     "double quotes as in the examples. For other strings, the quotes are",
415     "optional, but if the value conflicts with a reserved keyword, a syntax",
416     "error will occur. If your strings contain uppercase letters, this should",
417     "not happen.[PAR]",
418
419     "Index groups provided with the [TT]-n[tt] command-line option or",
420     "generated by default can be accessed with [TT]group NR[tt] or",
421     "[TT]group NAME[tt], where [TT]NR[tt] is a zero-based index of the group",
422     "and [TT]NAME[tt] is part of the name of the desired group.",
423     "The keyword [TT]group[tt] is optional if the whole selection is",
424     "provided from an index group.",
425     "To see a list of available groups in the interactive mode, press enter",
426     "in the beginning of a line.",
427 };
428
429 } // namespace
430
431 namespace gmx
432 {
433
434 namespace
435 {
436
437 /*! \internal \brief
438  * Help topic implementation for an individual selection method.
439  *
440  * \ingroup module_selection
441  */
442 class KeywordDetailsHelpTopic : public AbstractSimpleHelpTopic
443 {
444     public:
445         //! Initialize help topic for the given selection method.
446         KeywordDetailsHelpTopic(const std::string         &name,
447                                 const gmx_ana_selmethod_t &method)
448             : name_(name), method_(method)
449         {
450         }
451
452         virtual const char *name() const
453         {
454             return name_.c_str();
455         }
456         virtual const char *title() const
457         {
458             return NULL;
459         }
460
461     protected:
462         virtual std::string helpText() const
463         {
464             return concatenateStrings(method_.help.help, method_.help.nlhelp);
465         }
466
467     private:
468         std::string                name_;
469         const gmx_ana_selmethod_t &method_;
470
471         GMX_DISALLOW_COPY_AND_ASSIGN(KeywordDetailsHelpTopic);
472 };
473
474 /*! \internal \brief
475  * Custom help topic for printing a list of selection keywords.
476  *
477  * \ingroup module_selection
478  */
479 class KeywordsHelpTopic : public CompositeHelpTopic<KeywordsHelpText>
480 {
481     public:
482         KeywordsHelpTopic();
483
484         virtual void writeHelp(const HelpWriterContext &context) const;
485
486     private:
487         /*! \brief
488          * Container for known selection methods.
489          *
490          * The first item in the pair is the name of the selection method, and
491          * the second points to the static data structure that describes the
492          * method.
493          * The name in the first item may differ from the name of the static
494          * data structure if an alias is defined for that method.
495          */
496         typedef std::vector<std::pair<std::string,
497                                       const gmx_ana_selmethod_t *> >
498             MethodList;
499
500         /*! \brief
501          * Prints a brief list of keywords (selection methods) available.
502          *
503          * \param[in] context  Context for printing the help.
504          * \param[in] type     Only methods that return this type are printed.
505          * \param[in] bModifiers  If false, \ref SMETH_MODIFIER methods are
506          *      excluded, otherwise only them are printed.
507          */
508         void printKeywordList(const HelpWriterContext &context,
509                               e_selvalue_t type, bool bModifiers) const;
510
511         MethodList              methods_;
512 };
513
514 KeywordsHelpTopic::KeywordsHelpTopic()
515 {
516     // TODO: This is not a very elegant way of getting the list of selection
517     // methods, but this needs to be rewritten in any case if/when #652 is
518     // implemented.
519     boost::scoped_ptr<SelectionParserSymbolTable> symtab(
520             new SelectionParserSymbolTable);
521     gmx_ana_selmethod_register_defaults(symtab.get());
522
523     SelectionParserSymbolIterator symbol
524         = symtab->beginIterator(SelectionParserSymbol::MethodSymbol);
525     while (symbol != symtab->endIterator())
526     {
527         const std::string         &symname = symbol->name();
528         const gmx_ana_selmethod_t *method  = symbol->methodValue();
529         methods_.push_back(std::make_pair(std::string(symname), method));
530         if (method->help.nlhelp > 0 && method->help.help != NULL)
531         {
532             addSubTopic(HelpTopicPointer(
533                                 new KeywordDetailsHelpTopic(symname, *method)));
534         }
535         ++symbol;
536     }
537 }
538
539 void KeywordsHelpTopic::writeHelp(const HelpWriterContext &context) const
540 {
541     if (context.outputFormat() != eHelpOutputFormat_Console)
542     {
543         GMX_THROW(NotImplementedError(
544                           "Selection help is not implemented for this output format"));
545     }
546     // TODO: The markup here is not really appropriate, and printKeywordList()
547     // still prints raw text, but these are waiting for discussion of the
548     // markup format in #969.
549     writeBasicHelpTopic(context, *this, helpText());
550     context.writeTextBlock("[BR]");
551
552     // Print the list of keywords
553     context.writeTextBlock(
554             "Keywords that select atoms by an integer property:[BR]"
555             "(use in expressions or like \"atomnr 1 to 5 7 9\")[BR]");
556     printKeywordList(context, INT_VALUE, false);
557     context.writeTextBlock("[BR]");
558
559     context.writeTextBlock(
560             "Keywords that select atoms by a numeric property:[BR]"
561             "(use in expressions or like \"occupancy 0.5 to 1\")[BR]");
562     printKeywordList(context, REAL_VALUE, false);
563     context.writeTextBlock("[BR]");
564
565     context.writeTextBlock(
566             "Keywords that select atoms by a string property:[BR]"
567             "(use like \"name PATTERN [PATTERN] ...\")[BR]");
568     printKeywordList(context, STR_VALUE, false);
569     context.writeTextBlock("[BR]");
570
571     context.writeTextBlock(
572             "Additional keywords that directly select atoms:[BR]");
573     printKeywordList(context, GROUP_VALUE, false);
574     context.writeTextBlock("[BR]");
575
576     context.writeTextBlock(
577             "Keywords that directly evaluate to positions:[BR]"
578             "(see also \"positions\" subtopic)[BR]");
579     printKeywordList(context, POS_VALUE, false);
580     context.writeTextBlock("[BR]");
581
582     context.writeTextBlock("Additional keywords:[BR]");
583     printKeywordList(context, POS_VALUE, true);
584     printKeywordList(context, NO_VALUE, true);
585 }
586
587 void KeywordsHelpTopic::printKeywordList(const HelpWriterContext &context,
588                                          e_selvalue_t             type,
589                                          bool                     bModifiers) const
590 {
591     File &file = context.outputFile();
592     MethodList::const_iterator iter;
593     for (iter = methods_.begin(); iter != methods_.end(); ++iter)
594     {
595         const gmx_ana_selmethod_t &method = *iter->second;
596         bool bIsModifier                  = (method.flags & SMETH_MODIFIER) != 0;
597         if (method.type == type && bModifiers == bIsModifier)
598         {
599             bool bHasHelp = (method.help.nlhelp > 0 && method.help.help != NULL);
600             file.writeString(formatString(" %c ", bHasHelp ? '*' : ' '));
601             if (method.help.syntax != NULL)
602             {
603                 file.writeLine(method.help.syntax);
604             }
605             else
606             {
607                 std::string symname = iter->first;
608                 if (symname != method.name)
609                 {
610                     symname.append(formatString(" (synonym for %s)", method.name));
611                 }
612                 file.writeLine(symname);
613             }
614         }
615     }
616 }
617
618 }   // namespace
619
620 //! \cond libapi */
621 HelpTopicPointer createSelectionHelpTopic()
622 {
623     CompositeHelpTopicPointer root(new CompositeHelpTopic<CommonHelpText>);
624     root->registerSubTopic<SimpleHelpTopic<ArithmeticHelpText> >();
625     root->registerSubTopic<SimpleHelpTopic<CmdLineHelpText> >();
626     root->registerSubTopic<SimpleHelpTopic<EvaluationHelpText> >();
627     root->registerSubTopic<SimpleHelpTopic<ExamplesHelpText> >();
628     root->registerSubTopic<KeywordsHelpTopic>();
629     root->registerSubTopic<SimpleHelpTopic<LimitationsHelpText> >();
630     root->registerSubTopic<SimpleHelpTopic<PositionsHelpText> >();
631     root->registerSubTopic<SimpleHelpTopic<SyntaxHelpText> >();
632     return move(root);
633 }
634 //! \endcond
635
636 } // namespace gmx