2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2009,2010,2011,2012,2013, 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 functions in parsetree.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_selection
43 * \page page_module_selection_parser Selection parsing
45 * The selection parser is implemented in the following files:
47 * Tokenizer implemented using Flex, splits the input into tokens
48 * (scanner.c and scanner_flex.h are generated from this file).
49 * - scanner.h, scanner_internal.h, scanner_internal.cpp:
50 * Helper functions for scanner.l and for interfacing between
51 * scanner.l and parser.y. Functions in scanner_internal.h are only
52 * used from scanner.l, while scanner.h is used from the parser.
53 * - symrec.h, symrec.cpp:
54 * Functions used by the tokenizer to handle the symbol table, i.e.,
55 * the recognized keywords. Some basic keywords are hardcoded into
56 * scanner.l, but all method and variable references go through the
57 * symbol table, as do position evaluation keywords.
59 * Semantic rules for parsing the grammar
60 * (parser.cpp and parser.h are generated from this file by Bison).
61 * - parsetree.h, parsetree.cpp:
62 * Functions called from actions in parser.y to construct the
63 * evaluation elements corresponding to different grammar elements.
65 * Defines a function that processes the parameters of selection
66 * methods and initializes the children of the method element.
67 * - selectioncollection.h, selectioncollection.cpp:
68 * These files define the high-level public interface to the parser
69 * through SelectionCollection::parseFromStdin(),
70 * SelectionCollection::parseFromFile() and
71 * SelectionCollection::parseFromString().
73 * The basic control flow in the parser is as follows: when a parser function
74 * in SelectionCollection gets called, it performs some
75 * initialization, and then calls the _gmx_sel_yyparse() function generated
76 * by Bison. This function then calls _gmx_sel_yylex() to repeatedly read
77 * tokens from the input (more complex tasks related to token recognition
78 * and bookkeeping are done by functions in scanner_internal.cpp) and uses the
79 * grammar rules to decide what to do with them. Whenever a grammar rule
80 * matches, a corresponding function in parsetree.cpp is called to construct
81 * either a temporary representation for the object or a
82 * gmx::SelectionTreeElement object
83 * (some simple rules are handled internally in parser.y).
84 * When a complete selection has been parsed, the functions in parsetree.cpp
85 * also take care of updating the ::gmx_ana_selcollection_t structure
88 * The rest of this page describes the resulting gmx::SelectionTreeElement
90 * Before the selections can be evaluated, this tree needs to be passed to
91 * the selection compiler, which is described on a separate page:
92 * \ref page_module_selection_compiler
95 * \section selparser_tree Element tree constructed by the parser
97 * The parser initializes the following fields in all selection elements:
98 * gmx::SelectionTreeElement::name, gmx::SelectionTreeElement::type,
99 * gmx::SelectionTreeElement::v\c .type,
100 * gmx::SelectionTreeElement::flags, gmx::SelectionTreeElement::child, and
101 * gmx::SelectionTreeElement::next.
102 * Some other fields are also initialized for particular element types as
104 * Fields that are not initialized are set to zero, NULL, or other similar
108 * \subsection selparser_tree_root Root elements
110 * The parser creates a \ref SEL_ROOT selection element for each variable
111 * assignment and each selection. However, there are two exceptions that do
112 * not result in a \ref SEL_ROOT element (in these cases, only the symbol
113 * table is modified):
114 * - Variable assignments that assign a variable to another variable.
115 * - Variable assignments that assign a non-group constant.
117 * The \ref SEL_ROOT elements are linked together in a chain in the same order
120 * The children of the \ref SEL_ROOT elements can be used to distinguish
121 * the two types of root elements from each other:
122 * - For variable assignments, the first and only child is always
123 * a \ref SEL_SUBEXPR element.
124 * - For selections, the first child is a \ref SEL_EXPRESSION or a
125 * \ref SEL_MODIFIER element that evaluates the final positions (if the
126 * selection defines a constant position, the child is a \ref SEL_CONST).
127 * The rest of the children are \ref SEL_MODIFIER elements with
128 * \ref NO_VALUE, in the order given by the user.
130 * The name of the selection/variable is stored in
131 * gmx::SelectionTreeElement::cgrp\c .name.
132 * It is set to either the name provided by the user or the selection string
133 * for selections not explicitly named by the user.
134 * \ref SEL_ROOT or \ref SEL_SUBEXPR elements do not appear anywhere else.
137 * \subsection selparser_tree_const Constant elements
139 * \ref SEL_CONST elements are created for every constant that is required
140 * for later evaluation.
141 * Currently, \ref SEL_CONST elements can be present for
142 * - selections that consist of a constant position,
143 * - \ref GROUP_VALUE method parameters if provided using external index
146 * For group-valued elements, the value is stored in
147 * gmx::SelectionTreeElement::cgrp; other types of values are stored in
148 * gmx::SelectionTreeElement::v.
149 * Constants that appear as parameters for selection methods are not present
150 * in the selection tree unless they have \ref GROUP_VALUE.
151 * \ref SEL_CONST elements have no children.
154 * \subsection selparser_tree_method Method evaluation elements
156 * \ref SEL_EXPRESSION and \ref SEL_MODIFIER elements are treated very
157 * similarly. The \c gmx_ana_selmethod_t structure corresponding to the
158 * evaluation method is in gmx::SelectionTreeElement::method, and the method
159 * data in gmx::SelectionTreeElement::mdata has been allocated using
161 * If a non-standard reference position type was set,
162 * gmx::SelectionTreeElement::pc has also been created, but only the type has
164 * All children of these elements are of the type \ref SEL_SUBEXPRREF, and
165 * each describes a selection that needs to be evaluated to obtain a value
166 * for one parameter of the method.
167 * No children are present for parameters that were given a constant
168 * non-\ref GROUP_VALUE value.
169 * The children are sorted in the order in which the parameters appear in the
170 * \ref gmx_ana_selmethod_t structure.
172 * In addition to actual selection keywords, \ref SEL_EXPRESSION elements
173 * are used internally to implement numerical comparisons (e.g., "x < 5")
174 * and keyword matching (e.g., "resnr 1 to 3" or "name CA").
177 * \subsection selparser_tree_subexpr Subexpression elements
179 * \ref SEL_SUBEXPR elements only appear for variables, as described above.
180 * gmx::SelectionTreeElement::name points to the name of the variable (from the
181 * \ref SEL_ROOT element).
182 * The element always has exactly one child, which represents the value of
185 * \ref SEL_SUBEXPRREF elements are used for two purposes:
186 * - Variable references that need to be evaluated (i.e., there is a
187 * \ref SEL_SUBEXPR element for the variable) are represented using
188 * \ref SEL_SUBEXPRREF elements.
189 * In this case, gmx::SelectionTreeElement::param is NULL, and the first and
190 * only child of the element is the \ref SEL_SUBEXPR element of the
192 * Such references can appear anywhere where the variable value
193 * (the child of the \ref SEL_SUBEXPR element) would be valid.
194 * - Children of \ref SEL_EXPRESSION and \ref SEL_MODIFIER elements are
195 * always of this type. For these elements, gmx::SelectionTreeElement::param
196 * is initialized to point to the parameter that receives the value from
198 * Each such element has exactly one child, which can be of any type;
199 * the \ref SEL_SUBEXPR element of a variable is used if the value comes
200 * from a variable, otherwise the child type is not \ref SEL_SUBEXPR.
203 * \subsection selparser_tree_bool Boolean elements
205 * One \ref SEL_BOOLEAN element is created for each boolean keyword in the
206 * input, and the tree structure represents the evaluation order.
207 * The gmx::SelectionTreeElement::boolt type gives the type of the operation.
208 * Each element has exactly two children (one for \ref BOOL_NOT elements),
209 * which are in the order given in the input.
210 * The children always have \ref GROUP_VALUE, but different element types
214 * \subsection selparser_tree_arith Arithmetic elements
216 * One \ref SEL_ARITHMETIC element is created for each arithmetic operation in
217 * the input, and the tree structure represents the evaluation order.
218 * The gmx::SelectionTreeElement::optype type gives the name of the operation.
219 * Each element has exactly two children (one for unary negation elements),
220 * which are in the order given in the input.
225 #include <boost/exception_ptr.hpp>
226 #include <boost/shared_ptr.hpp>
228 #include "gromacs/fileio/futil.h"
229 #include "gromacs/legacyheaders/smalloc.h"
230 #include "gromacs/legacyheaders/string2.h"
232 #include "gromacs/onlinehelp/helpmanager.h"
233 #include "gromacs/onlinehelp/helpwritercontext.h"
234 #include "gromacs/selection/poscalc.h"
235 #include "gromacs/selection/selection.h"
236 #include "gromacs/selection/selmethod.h"
237 #include "gromacs/utility/exceptions.h"
238 #include "gromacs/utility/file.h"
239 #include "gromacs/utility/messagestringcollector.h"
240 #include "gromacs/utility/stringutil.h"
242 #include "keywords.h"
243 #include "parsetree.h"
244 #include "selectioncollection-impl.h"
251 using gmx::SelectionParserValue;
252 using gmx::SelectionParserValueList;
253 using gmx::SelectionParserValueListPointer;
254 using gmx::SelectionParserParameter;
255 using gmx::SelectionParserParameterList;
256 using gmx::SelectionParserParameterListPointer;
257 using gmx::SelectionParserValue;
258 using gmx::SelectionTreeElement;
259 using gmx::SelectionTreeElementPointer;
262 _gmx_selparser_error(yyscan_t scanner, const char *fmt, ...)
264 gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
265 // FIXME: Use an arbitrary length buffer.
269 vsprintf(buf, fmt, ap);
275 _gmx_selparser_handle_exception(yyscan_t scanner, const std::exception &ex)
277 if (dynamic_cast<const gmx::UserInputError *>(&ex) != NULL)
279 // TODO: Consider whether also the non-interactive parser should
280 // postpone the exception such that the whole selection can be added as
282 if (_gmx_sel_is_lexer_interactive(scanner))
284 // TODO: Handle exceptions that printing the message may produce.
285 gmx::formatExceptionMessageToFile(stderr, ex);
289 _gmx_sel_lexer_set_exception(scanner, boost::current_exception());
296 /********************************************************************
297 * SelectionParserValue
300 SelectionParserValue::SelectionParserValue(e_selvalue_t type)
303 memset(&u, 0, sizeof(u));
306 SelectionParserValue::SelectionParserValue(
307 const SelectionTreeElementPointer &expr)
308 : type(expr->v.type), expr(expr)
310 memset(&u, 0, sizeof(u));
313 /********************************************************************
314 * SelectionParserParameter
317 SelectionParserParameter::SelectionParserParameter(
319 SelectionParserValueListPointer values)
320 : name_(name != NULL ? name : ""),
321 values_(values ? move(values)
322 : SelectionParserValueListPointer(new SelectionParserValueList))
329 * \param[in,out] sel Root of the selection element tree to initialize.
330 * \param[in] scanner Scanner data structure.
331 * \returns 0 on success, an error code on error.
333 * Propagates the \ref SEL_DYNAMIC flag from the children of \p sel to \p sel
334 * (if any child of \p sel is dynamic, \p sel is also marked as such).
335 * The \ref SEL_DYNAMIC flag is also set for \ref SEL_EXPRESSION elements with
337 * Also, sets one of the \ref SEL_SINGLEVAL, \ref SEL_ATOMVAL, or
338 * \ref SEL_VARNUMVAL flags, either based on the children or on the type of
339 * the selection method.
340 * If the types of the children conflict, an error is returned.
342 * The flags of the children of \p sel are also updated if not done earlier.
343 * The flags are initialized only once for any element; if \ref SEL_FLAGSSET
344 * is set for an element, the function returns immediately, and the recursive
345 * operation does not descend beyond such elements.
348 _gmx_selelem_update_flags(const SelectionTreeElementPointer &sel,
351 bool bUseChildType = false;
352 bool bOnlySingleChildren;
354 /* Return if the flags have already been set */
355 if (sel->flags & SEL_FLAGSSET)
359 /* Set the flags based on the current element type */
364 sel->flags |= SEL_SINGLEVAL;
365 bUseChildType = false;
369 if (sel->u.expr.method->flags & SMETH_DYNAMIC)
371 sel->flags |= SEL_DYNAMIC;
373 if (sel->u.expr.method->flags & SMETH_SINGLEVAL)
375 sel->flags |= SEL_SINGLEVAL;
377 else if (sel->u.expr.method->flags & SMETH_VARNUMVAL)
379 sel->flags |= SEL_VARNUMVAL;
383 sel->flags |= SEL_ATOMVAL;
385 bUseChildType = false;
389 sel->flags |= SEL_ATOMVAL;
390 bUseChildType = false;
394 if (sel->v.type != NO_VALUE)
396 sel->flags |= SEL_VARNUMVAL;
398 bUseChildType = false;
402 bUseChildType = false;
408 bUseChildType = true;
411 /* Loop through children to propagate their flags upwards */
412 bOnlySingleChildren = true;
413 SelectionTreeElementPointer child = sel->child;
416 /* Update the child */
417 _gmx_selelem_update_flags(child, scanner);
418 /* Propagate the dynamic flag */
419 sel->flags |= (child->flags & SEL_DYNAMIC);
420 /* Propagate the type flag if necessary and check for problems */
423 if ((sel->flags & SEL_VALTYPEMASK)
424 && !(sel->flags & child->flags & SEL_VALTYPEMASK))
426 _gmx_selparser_error(scanner, "invalid combination of selection expressions");
427 // FIXME: Use an exception.
430 sel->flags |= (child->flags & SEL_VALTYPEMASK);
432 if (!(child->flags & SEL_SINGLEVAL))
434 bOnlySingleChildren = false;
439 /* For arithmetic expressions consisting only of single values,
440 * the result is also a single value. */
441 if (sel->type == SEL_ARITHMETIC && bOnlySingleChildren)
443 sel->flags = (sel->flags & ~SEL_VALTYPEMASK) | SEL_SINGLEVAL;
445 /* For root elements, the type should be propagated here, after the
446 * children have been updated. */
447 if (sel->type == SEL_ROOT)
449 GMX_ASSERT(sel->child, "Root elements should always have a child");
450 sel->flags |= (sel->child->flags & SEL_VALTYPEMASK);
452 /* Mark that the flags are set */
453 sel->flags |= SEL_FLAGSSET;
457 * \param[in,out] sel Selection element to initialize.
458 * \param[in] scanner Scanner data structure.
460 * A deep copy of the parameters is made to allow several
461 * expressions with the same method to coexist peacefully.
462 * Calls sel_datafunc() if one is specified for the method.
465 _gmx_selelem_init_method_params(const SelectionTreeElementPointer &sel,
469 gmx_ana_selparam_t *orgparam;
470 gmx_ana_selparam_t *param;
474 nparams = sel->u.expr.method->nparams;
475 orgparam = sel->u.expr.method->param;
476 snew(param, nparams);
477 memcpy(param, orgparam, nparams*sizeof(gmx_ana_selparam_t));
478 for (i = 0; i < nparams; ++i)
480 param[i].flags &= ~SPAR_SET;
481 _gmx_selvalue_setstore(¶m[i].val, NULL);
482 if (param[i].flags & SPAR_VARNUM)
484 param[i].val.nr = -1;
486 /* Duplicate the enum value array if it is given statically */
487 if ((param[i].flags & SPAR_ENUMVAL) && orgparam[i].val.u.ptr != NULL)
491 /* Count the values */
493 while (orgparam[i].val.u.s[n] != NULL)
497 _gmx_selvalue_reserve(¶m[i].val, n+1);
498 memcpy(param[i].val.u.s, orgparam[i].val.u.s,
499 (n+1)*sizeof(param[i].val.u.s[0]));
503 if (sel->u.expr.method->init_data)
505 mdata = sel->u.expr.method->init_data(nparams, param);
507 if (sel->u.expr.method->set_poscoll)
509 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
511 sel->u.expr.method->set_poscoll(&sc->pcc, mdata);
513 /* Store the values */
514 sel->u.expr.method->param = param;
515 sel->u.expr.mdata = mdata;
519 * \param[in,out] sel Selection element to initialize.
520 * \param[in] method Selection method to set.
521 * \param[in] scanner Scanner data structure.
523 * Makes a copy of \p method and stores it in \p sel->u.expr.method,
524 * and calls _gmx_selelem_init_method_params();
527 _gmx_selelem_set_method(const SelectionTreeElementPointer &sel,
528 gmx_ana_selmethod_t *method,
531 _gmx_selelem_set_vtype(sel, method->type);
532 sel->setName(method->name);
533 snew(sel->u.expr.method, 1);
534 memcpy(sel->u.expr.method, method, sizeof(gmx_ana_selmethod_t));
535 _gmx_selelem_init_method_params(sel, scanner);
539 * Initializes the reference position calculation for a \ref SEL_EXPRESSION
542 * \param[in,out] pcc Position calculation collection to use.
543 * \param[in,out] sel Selection element to initialize.
544 * \param[in] rpost Reference position type to use (NULL = default).
545 * \param[in] scanner Scanner data structure.
546 * \returns 0 on success, a non-zero error code on error.
549 set_refpos_type(gmx::PositionCalculationCollection *pcc,
550 const SelectionTreeElementPointer &sel,
551 const char *rpost, yyscan_t scanner)
558 if (sel->u.expr.method->pupdate)
560 /* By default, use whole residues/molecules. */
562 = pcc->createCalculationFromEnum(rpost, POS_COMPLWHOLE);
566 // TODO: Should this be treated as a real error?
567 _gmx_selparser_error(scanner, "modifier '%s' is not applicable for '%s'",
568 rpost, sel->u.expr.method->name);
572 gmx::SelectionTreeElementPointer
573 _gmx_sel_init_arithmetic(const gmx::SelectionTreeElementPointer &left,
574 const gmx::SelectionTreeElementPointer &right,
575 char op, yyscan_t /* scanner */)
577 SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_ARITHMETIC));
578 sel->v.type = REAL_VALUE;
581 case '+': sel->u.arith.type = ARITH_PLUS; break;
582 case '-': sel->u.arith.type = (right ? ARITH_MINUS : ARITH_NEG); break;
583 case '*': sel->u.arith.type = ARITH_MULT; break;
584 case '/': sel->u.arith.type = ARITH_DIV; break;
585 case '^': sel->u.arith.type = ARITH_EXP; break;
591 sel->u.arith.opstr = strdup(buf);
593 sel->child->next = right;
598 * \param[in] left Selection element for the left hand side.
599 * \param[in] right Selection element for the right hand side.
600 * \param[in] cmpop String representation of the comparison operator.
601 * \param[in] scanner Scanner data structure.
602 * \returns The created selection element.
604 * This function handles the creation of a gmx::SelectionTreeElement object for
605 * comparison expressions.
607 SelectionTreeElementPointer
608 _gmx_sel_init_comparison(const SelectionTreeElementPointer &left,
609 const SelectionTreeElementPointer &right,
610 const char *cmpop, yyscan_t scanner)
612 gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
613 gmx::MessageStringContext context(errors, "In comparison initialization");
615 SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_EXPRESSION));
616 _gmx_selelem_set_method(sel, &sm_compare, scanner);
618 SelectionParserParameterList params;
620 // Create the parameter for the left expression.
621 name = left->v.type == INT_VALUE ? "int1" : "real1";
622 params.push_back(SelectionParserParameter::createFromExpression(name, left));
623 // Create the parameter for the right expression.
624 name = right->v.type == INT_VALUE ? "int2" : "real2";
625 params.push_back(SelectionParserParameter::createFromExpression(name, right));
626 // Create the parameter for the operator.
628 SelectionParserParameter::create(
629 "op", SelectionParserValue::createString(cmpop)));
630 if (!_gmx_sel_parse_params(params, sel->u.expr.method->nparams,
631 sel->u.expr.method->param, sel, scanner))
633 return SelectionTreeElementPointer();
640 * Implementation method for keyword expression creation.
642 * \param[in] method Method to use.
643 * \param[in] matchType String matching type (only used if \p method is
644 * a string keyword and \p args is not empty.
645 * \param[in] args Pointer to the first argument.
646 * \param[in] rpost Reference position type to use (NULL = default).
647 * \param[in] scanner Scanner data structure.
648 * \returns The created selection element.
650 * This function handles the creation of a gmx::SelectionTreeElement object for
651 * selection methods that do not take parameters.
653 static SelectionTreeElementPointer
654 init_keyword_internal(gmx_ana_selmethod_t *method,
655 gmx::SelectionStringMatchType matchType,
656 SelectionParserValueListPointer args,
657 const char *rpost, yyscan_t scanner)
659 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
661 gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
663 sprintf(buf, "In keyword '%s'", method->name);
664 gmx::MessageStringContext context(errors, buf);
666 if (method->nparams > 0)
668 // TODO: Would assert be better?
669 GMX_THROW(gmx::InternalError(
670 "Keyword initialization called with non-keyword method"));
673 SelectionTreeElementPointer root(new SelectionTreeElement(SEL_EXPRESSION));
674 SelectionTreeElementPointer child = root;
675 _gmx_selelem_set_method(child, method, scanner);
677 /* Initialize the evaluation of keyword matching if values are provided */
680 gmx_ana_selmethod_t *kwmethod;
681 switch (method->type)
683 case INT_VALUE: kwmethod = &sm_keyword_int; break;
684 case REAL_VALUE: kwmethod = &sm_keyword_real; break;
685 case STR_VALUE: kwmethod = &sm_keyword_str; break;
687 GMX_THROW(gmx::InternalError(
688 "Unknown type for keyword selection"));
690 /* Initialize the selection element */
691 root.reset(new SelectionTreeElement(SEL_EXPRESSION));
692 _gmx_selelem_set_method(root, kwmethod, scanner);
693 if (method->type == STR_VALUE)
695 _gmx_selelem_set_kwstr_match_type(root, matchType);
697 SelectionParserParameterList params;
699 SelectionParserParameter::createFromExpression(NULL, child));
700 params.push_back(SelectionParserParameter::create(NULL, move(args)));
701 if (!_gmx_sel_parse_params(params, root->u.expr.method->nparams,
702 root->u.expr.method->param, root, scanner))
704 return SelectionTreeElementPointer();
707 set_refpos_type(&sc->pcc, child, rpost, scanner);
713 * \param[in] method Method to use.
714 * \param[in] args Pointer to the first argument.
715 * \param[in] rpost Reference position type to use (NULL = default).
716 * \param[in] scanner Scanner data structure.
717 * \returns The created selection element.
719 * This function handles the creation of a gmx::SelectionTreeElement object for
720 * selection methods that do not take parameters.
722 SelectionTreeElementPointer
723 _gmx_sel_init_keyword(gmx_ana_selmethod_t *method,
724 SelectionParserValueListPointer args,
725 const char *rpost, yyscan_t scanner)
727 return init_keyword_internal(method, gmx::eStringMatchType_Auto, move(args),
732 * \param[in] method Method to use.
733 * \param[in] matchType String matching type.
734 * \param[in] args Pointer to the first argument.
735 * \param[in] rpost Reference position type to use (NULL = default).
736 * \param[in] scanner Scanner data structure.
737 * \returns The created selection element.
739 * This function handles the creation of a gmx::SelectionTreeElement object for
740 * keyword string matching.
742 SelectionTreeElementPointer
743 _gmx_sel_init_keyword_strmatch(gmx_ana_selmethod_t *method,
744 gmx::SelectionStringMatchType matchType,
745 SelectionParserValueListPointer args,
746 const char *rpost, yyscan_t scanner)
748 GMX_RELEASE_ASSERT(method->type == STR_VALUE,
749 "String keyword method called for a non-string-valued method");
750 GMX_RELEASE_ASSERT(args && !args->empty(),
751 "String keyword matching method called without any values");
752 return init_keyword_internal(method, matchType, move(args), rpost, scanner);
756 * \param[in] method Method to use for initialization.
757 * \param[in] params Pointer to the first parameter.
758 * \param[in] rpost Reference position type to use (NULL = default).
759 * \param[in] scanner Scanner data structure.
760 * \returns The created selection element.
762 * This function handles the creation of a gmx::SelectionTreeElement object for
763 * selection methods that take parameters.
765 * Part of the behavior of the \c same selection keyword is hardcoded into
766 * this function (or rather, into _gmx_selelem_custom_init_same()) to allow the
767 * use of any keyword in \c "same KEYWORD as" without requiring special
768 * handling somewhere else (or sacrificing the simple syntax).
770 SelectionTreeElementPointer
771 _gmx_sel_init_method(gmx_ana_selmethod_t *method,
772 SelectionParserParameterListPointer params,
773 const char *rpost, yyscan_t scanner)
775 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
778 gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
780 sprintf(buf, "In keyword '%s'", method->name);
781 gmx::MessageStringContext context(errors, buf);
783 _gmx_sel_finish_method(scanner);
784 /* The "same" keyword needs some custom massaging of the parameters. */
785 rc = _gmx_selelem_custom_init_same(&method, params, scanner);
788 return SelectionTreeElementPointer();
790 SelectionTreeElementPointer root(new SelectionTreeElement(SEL_EXPRESSION));
791 _gmx_selelem_set_method(root, method, scanner);
792 /* Process the parameters */
793 if (!_gmx_sel_parse_params(*params, root->u.expr.method->nparams,
794 root->u.expr.method->param, root, scanner))
796 return SelectionTreeElementPointer();
798 set_refpos_type(&sc->pcc, root, rpost, scanner);
804 * \param[in] method Modifier to use for initialization.
805 * \param[in] params Pointer to the first parameter.
806 * \param[in] sel Selection element that the modifier should act on.
807 * \param[in] scanner Scanner data structure.
808 * \returns The created selection element.
810 * This function handles the creation of a gmx::SelectionTreeElement object for
811 * selection modifiers.
813 SelectionTreeElementPointer
814 _gmx_sel_init_modifier(gmx_ana_selmethod_t *method,
815 SelectionParserParameterListPointer params,
816 const SelectionTreeElementPointer &sel, yyscan_t scanner)
818 gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
820 sprintf(buf, "In keyword '%s'", method->name);
821 gmx::MessageStringContext context(errors, buf);
823 _gmx_sel_finish_method(scanner);
824 SelectionTreeElementPointer modifier(new SelectionTreeElement(SEL_MODIFIER));
825 _gmx_selelem_set_method(modifier, method, scanner);
826 SelectionTreeElementPointer root;
827 if (method->type == NO_VALUE)
829 SelectionTreeElementPointer child = sel;
834 child->next = modifier;
840 SelectionParserParameter::createFromExpression(NULL, sel));
843 /* Process the parameters */
844 if (!_gmx_sel_parse_params(*params, modifier->u.expr.method->nparams,
845 modifier->u.expr.method->param, modifier, scanner))
847 return SelectionTreeElementPointer();
854 * \param[in] expr Input selection element for the position calculation.
855 * \param[in] type Reference position type or NULL for default.
856 * \param[in] scanner Scanner data structure.
857 * \returns The created selection element.
859 * This function handles the creation of a gmx::SelectionTreeElement object for
860 * evaluation of reference positions.
862 SelectionTreeElementPointer
863 _gmx_sel_init_position(const SelectionTreeElementPointer &expr,
864 const char *type, yyscan_t scanner)
866 gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
868 sprintf(buf, "In position evaluation");
869 gmx::MessageStringContext context(errors, buf);
871 SelectionTreeElementPointer root(new SelectionTreeElement(SEL_EXPRESSION));
872 _gmx_selelem_set_method(root, &sm_keyword_pos, scanner);
873 _gmx_selelem_set_kwpos_type(root.get(), type);
874 /* Create the parameters for the parameter parser. */
875 SelectionParserParameterList params;
876 params.push_back(SelectionParserParameter::createFromExpression(NULL, expr));
877 /* Parse the parameters. */
878 if (!_gmx_sel_parse_params(params, root->u.expr.method->nparams,
879 root->u.expr.method->param, root, scanner))
881 return SelectionTreeElementPointer();
888 * \param[in] x,y,z Coordinates for the position.
889 * \returns The creates selection element.
891 SelectionTreeElementPointer
892 _gmx_sel_init_const_position(real x, real y, real z)
896 SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_CONST));
897 _gmx_selelem_set_vtype(sel, POS_VALUE);
898 _gmx_selvalue_reserve(&sel->v, 1);
902 gmx_ana_pos_init_const(sel->v.u.p, pos);
907 * \param[in] name Name of an index group to search for.
908 * \param[in] scanner Scanner data structure.
909 * \returns The created selection element.
911 * See gmx_ana_indexgrps_find() for information on how \p name is matched
912 * against the index groups.
914 SelectionTreeElementPointer
915 _gmx_sel_init_group_by_name(const char *name, yyscan_t scanner)
918 SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_GROUPREF));
919 _gmx_selelem_set_vtype(sel, GROUP_VALUE);
920 sel->setName(gmx::formatString("group \"%s\"", name));
921 sel->u.gref.name = strdup(name);
924 if (_gmx_sel_lexer_has_groups_set(scanner))
926 gmx_ana_indexgrps_t *grps = _gmx_sel_lexer_indexgrps(scanner);
927 sel->resolveIndexGroupReference(grps);
934 * \param[in] id Zero-based index number of the group to extract.
935 * \param[in] scanner Scanner data structure.
936 * \returns The created selection element.
938 SelectionTreeElementPointer
939 _gmx_sel_init_group_by_id(int id, yyscan_t scanner)
941 SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_GROUPREF));
942 _gmx_selelem_set_vtype(sel, GROUP_VALUE);
943 sel->setName(gmx::formatString("group %d", id));
944 sel->u.gref.name = NULL;
947 if (_gmx_sel_lexer_has_groups_set(scanner))
949 gmx_ana_indexgrps_t *grps = _gmx_sel_lexer_indexgrps(scanner);
950 sel->resolveIndexGroupReference(grps);
957 * \param[in,out] sel Value of the variable.
958 * \returns The created selection element that references \p sel.
960 * The reference count of \p sel is updated, but no other modifications are
963 SelectionTreeElementPointer
964 _gmx_sel_init_variable_ref(const SelectionTreeElementPointer &sel)
966 SelectionTreeElementPointer ref;
968 if (sel->v.type == POS_VALUE && sel->type == SEL_CONST)
974 ref.reset(new SelectionTreeElement(SEL_SUBEXPRREF));
975 _gmx_selelem_set_vtype(ref, sel->v.type);
976 ref->setName(sel->name());
983 * \param[in] name Name for the selection
984 * (if NULL, a default name is constructed).
985 * \param[in] sel The selection element that evaluates the selection.
986 * \param scanner Scanner data structure.
987 * \returns The created root selection element.
989 * This function handles the creation of root (\ref SEL_ROOT)
990 * gmx::SelectionTreeElement objects for selections.
992 SelectionTreeElementPointer
993 _gmx_sel_init_selection(const char *name,
994 const SelectionTreeElementPointer &sel,
997 gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
999 sprintf(buf, "In selection '%s'", _gmx_sel_lexer_pselstr(scanner));
1000 gmx::MessageStringContext context(errors, buf);
1002 if (sel->v.type != POS_VALUE)
1004 /* FIXME: Better handling of this error */
1005 GMX_THROW(gmx::InternalError(
1006 "Each selection must evaluate to a position"));
1009 SelectionTreeElementPointer root(new SelectionTreeElement(SEL_ROOT));
1013 root->setName(name);
1015 /* Update the flags */
1016 _gmx_selelem_update_flags(root, scanner);
1018 root->fillNameIfMissing(_gmx_sel_lexer_pselstr(scanner));
1020 /* Print out some information if the parser is interactive */
1021 if (_gmx_sel_is_lexer_interactive(scanner))
1023 fprintf(stderr, "Selection '%s' parsed\n",
1024 _gmx_sel_lexer_pselstr(scanner));
1032 * \param[in] name Name of the variable.
1033 * \param[in] expr The selection element that evaluates the variable.
1034 * \param scanner Scanner data structure.
1035 * \returns The created root selection element.
1037 * This function handles the creation of root gmx::SelectionTreeElement objects
1038 * for variable assignments. A \ref SEL_ROOT element and a \ref SEL_SUBEXPR
1039 * element are both created.
1041 SelectionTreeElementPointer
1042 _gmx_sel_assign_variable(const char *name,
1043 const SelectionTreeElementPointer &expr,
1046 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
1047 const char *pselstr = _gmx_sel_lexer_pselstr(scanner);
1048 SelectionTreeElementPointer root;
1050 gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
1052 sprintf(buf, "In selection '%s'", pselstr);
1053 gmx::MessageStringContext context(errors, buf);
1055 _gmx_selelem_update_flags(expr, scanner);
1056 /* Check if this is a constant non-group value */
1057 if (expr->type == SEL_CONST && expr->v.type != GROUP_VALUE)
1059 /* If so, just assign the constant value to the variable */
1060 sc->symtab->addVariable(name, expr);
1063 /* Check if we are assigning a variable to another variable */
1064 if (expr->type == SEL_SUBEXPRREF)
1066 /* If so, make a simple alias */
1067 sc->symtab->addVariable(name, expr->child);
1070 /* Create the root element */
1071 root.reset(new SelectionTreeElement(SEL_ROOT));
1072 root->setName(name);
1073 /* Create the subexpression element */
1074 root->child.reset(new SelectionTreeElement(SEL_SUBEXPR));
1075 root->child->setName(name);
1076 _gmx_selelem_set_vtype(root->child, expr->v.type);
1077 root->child->child = expr;
1079 _gmx_selelem_update_flags(root, scanner);
1080 /* Add the variable to the symbol table */
1081 sc->symtab->addVariable(name, root->child);
1083 srenew(sc->varstrs, sc->nvars + 1);
1084 sc->varstrs[sc->nvars] = strdup(pselstr);
1086 if (_gmx_sel_is_lexer_interactive(scanner))
1088 fprintf(stderr, "Variable '%s' parsed\n", pselstr);
1094 * \param sel Selection to append (can be NULL, in which
1095 * case nothing is done).
1096 * \param last Last selection, or NULL if not present or not known.
1097 * \param scanner Scanner data structure.
1098 * \returns The last selection after the append.
1100 * Appends \p sel after the last root element, and returns either \p sel
1101 * (if it was non-NULL) or the last element (if \p sel was NULL).
1103 SelectionTreeElementPointer
1104 _gmx_sel_append_selection(const SelectionTreeElementPointer &sel,
1105 SelectionTreeElementPointer last,
1108 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
1110 /* Append sel after last, or the last element of sc if last is NULL */
1131 /* Initialize a selection object if necessary */
1135 /* Add the new selection to the collection if it is not a variable. */
1136 if (sel->child->type != SEL_SUBEXPR)
1138 gmx::SelectionDataPointer selPtr(
1139 new gmx::internal::SelectionData(
1140 sel.get(), _gmx_sel_lexer_pselstr(scanner)));
1141 sc->sel.push_back(gmx::move(selPtr));
1144 /* Clear the selection string now that we've saved it */
1145 _gmx_sel_lexer_clear_pselstr(scanner);
1150 * \param[in] scanner Scanner data structure.
1151 * \returns true if the parser should finish, false if parsing should
1154 * This function is called always after _gmx_sel_append_selection() to
1155 * check whether a sufficient number of selections has already been provided.
1156 * This is used to terminate interactive parsers when the correct number of
1157 * selections has been provided.
1160 _gmx_sel_parser_should_finish(yyscan_t scanner)
1162 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
1163 return (int)sc->sel.size() == _gmx_sel_lexer_exp_selcount(scanner);
1167 * \param[in] scanner Scanner data structure.
1170 _gmx_sel_handle_empty_cmd(yyscan_t scanner)
1172 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
1173 gmx_ana_indexgrps_t *grps = _gmx_sel_lexer_indexgrps(scanner);
1176 if (!_gmx_sel_is_lexer_interactive(scanner))
1183 fprintf(stderr, "Available index groups:\n");
1184 gmx_ana_indexgrps_print(stderr, _gmx_sel_lexer_indexgrps(scanner), 0);
1186 if (sc->nvars > 0 || !sc->sel.empty())
1188 fprintf(stderr, "Currently provided selections:\n");
1189 for (i = 0; i < sc->nvars; ++i)
1191 fprintf(stderr, " %s\n", sc->varstrs[i]);
1193 for (i = 0; i < (int)sc->sel.size(); ++i)
1195 fprintf(stderr, " %2d. %s\n", i+1, sc->sel[i]->selectionText());
1201 * \param[in] topic Topic for which help was requested, or NULL for general
1203 * \param[in] scanner Scanner data structure.
1205 * \p topic is freed by this function.
1208 _gmx_sel_handle_help_cmd(const SelectionParserValueListPointer &topic,
1211 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
1213 if (sc->rootHelp.get() == NULL)
1215 sc->rootHelp = gmx::createSelectionHelpTopic();
1217 gmx::HelpWriterContext context(&gmx::File::standardError(),
1218 gmx::eHelpOutputFormat_Console);
1219 gmx::HelpManager manager(*sc->rootHelp, context);
1222 SelectionParserValueList::const_iterator value;
1223 for (value = topic->begin(); value != topic->end(); ++value)
1225 manager.enterTopic(value->stringValue());
1228 catch (const gmx::InvalidInputError &ex)
1230 fprintf(stderr, "%s\n", ex.what());
1233 manager.writeCurrentTopic();