src/gromacs/selection/parsetree.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 parsetree.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 /*! \internal
  43  * \page page_module_selection_parser Selection parsing
  44  *
  45  * The selection parser is implemented in the following files:
  46  *  - scanner.l:
  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.
  58  *  - parser.y:
  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.
  64  *  - params.c:
  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().
  72  *
  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
  86  * appropriately.
  87  *
  88  * The rest of this page describes the resulting gmx::SelectionTreeElement
  89  * object tree.
  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
  93  *
  94  *
  95  * \section selparser_tree Element tree constructed by the parser
  96  *
  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
 103  * discussed below.
 104  * Fields that are not initialized are set to zero, NULL, or other similar
 105  * value.
 106  *
 107  *
 108  * \subsection selparser_tree_root Root elements
 109  *
 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.
 116  *  .
 117  * The \ref SEL_ROOT elements are linked together in a chain in the same order
 118  * as in the input.
 119  *
 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.
 129  *  .
 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.
 135  *
 136  *
 137  * \subsection selparser_tree_const Constant elements
 138  *
 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
 144  *    groups,
 145  *  .
 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.
 152  *
 153  *
 154  * \subsection selparser_tree_method Method evaluation elements
 155  *
 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
 160  * sel_datafunc().
 161  * If a non-standard reference position type was set,
 162  * gmx::SelectionTreeElement::pc has also been created, but only the type has
 163  * been set.
 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.
 171  *
 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").
 175  *
 176  *
 177  * \subsection selparser_tree_subexpr Subexpression elements
 178  *
 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
 183  * the variable.
 184  *
 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
 191  *    variable.
 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
 197  *    the expression.
 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.
 201  *
 202  *
 203  * \subsection selparser_tree_bool Boolean elements
 204  *
 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
 211  * are possible.
 212  *
 213  *
 214  * \subsection selparser_tree_arith Arithmetic elements
 215  *
 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.
 221  */
 222 #include "gmxpre.h"
 223
 224 #include "parsetree.h"
 225
 226 #include <stdarg.h>
 227 #include <stdio.h>
 228
 229 #include <boost/exception_ptr.hpp>
 230 #include <boost/shared_ptr.hpp>
 231
 232 #include "gromacs/selection/selection.h"
 233 #include "gromacs/utility/cstringutil.h"
 234 #include "gromacs/utility/exceptions.h"
 235 #include "gromacs/utility/file.h"
 236 #include "gromacs/utility/messagestringcollector.h"
 237 #include "gromacs/utility/smalloc.h"
 238 #include "gromacs/utility/stringutil.h"
 239
 240 #include "keywords.h"
 241 #include "poscalc.h"
 242 #include "scanner.h"
 243 #include "selectioncollection-impl.h"
 244 #include "selelem.h"
 245 #include "selmethod.h"
 246 #include "symrec.h"
 247
 248 using gmx::SelectionParserValue;
 249 using gmx::SelectionParserValueList;
 250 using gmx::SelectionParserValueListPointer;
 251 using gmx::SelectionParserParameter;
 252 using gmx::SelectionParserParameterList;
 253 using gmx::SelectionParserParameterListPointer;
 254 using gmx::SelectionParserValue;
 255 using gmx::SelectionTreeElement;
 256 using gmx::SelectionTreeElementPointer;
 257
 258 void
 259 _gmx_selparser_error(yyscan_t scanner, const char *fmt, ...)
 260 {
 261     gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
 262     // FIXME: Use an arbitrary length buffer.
 263     char    buf[1024];
 264     va_list ap;
 265     va_start(ap, fmt);
 266     vsnprintf(buf, 1024, fmt, ap);
 267     va_end(ap);
 268     errors->append(buf);
 269 }
 270
 271 bool
 272 _gmx_selparser_handle_exception(yyscan_t scanner, const std::exception &ex)
 273 {
 274     if (dynamic_cast<const gmx::UserInputError *>(&ex) != NULL)
 275     {
 276         // TODO: Consider whether also the non-interactive parser should
 277         // postpone the exception such that the whole selection can be added as
 278         // context.
 279         if (_gmx_sel_is_lexer_interactive(scanner))
 280         {
 281             // TODO: Handle exceptions that printing the message may produce.
 282             gmx::formatExceptionMessageToFile(stderr, ex);
 283             return true;
 284         }
 285     }
 286     _gmx_sel_lexer_set_exception(scanner, boost::current_exception());
 287     return false;
 288 }
 289
 290 namespace gmx
 291 {
 292
 293 /********************************************************************
 294  * SelectionParserValue
 295  */
 296
 297 SelectionParserValue::SelectionParserValue(e_selvalue_t type)
 298     : type(type)
 299 {
 300     memset(&u, 0, sizeof(u));
 301 }
 302
 303 SelectionParserValue::SelectionParserValue(
 304         const SelectionTreeElementPointer &expr)
 305     : type(expr->v.type), expr(expr)
 306 {
 307     memset(&u, 0, sizeof(u));
 308 }
 309
 310 /********************************************************************
 311  * SelectionParserParameter
 312  */
 313
 314 SelectionParserParameter::SelectionParserParameter(
 315         const char                     *name,
 316         SelectionParserValueListPointer values)
 317     : name_(name != NULL ? name : ""),
 318       values_(values ? move(values)
 319               : SelectionParserValueListPointer(new SelectionParserValueList))
 320 {
 321 }
 322
 323 } // namespace gmx
 324
 325 /*!
 326  * \param[in,out] sel  Root of the selection element tree to initialize.
 327  *
 328  * Propagates the \ref SEL_DYNAMIC flag from the children of \p sel to \p sel
 329  * (if any child of \p sel is dynamic, \p sel is also marked as such).
 330  * The \ref SEL_DYNAMIC flag is also set for \ref SEL_EXPRESSION elements with
 331  * a dynamic method.
 332  * Also, sets one of the \ref SEL_SINGLEVAL, \ref SEL_ATOMVAL, or
 333  * \ref SEL_VARNUMVAL flags, either based on the children or on the type of
 334  * the selection method.
 335  * If the types of the children conflict, an error is returned.
 336  *
 337  * The flags of the children of \p sel are also updated if not done earlier.
 338  * The flags are initialized only once for any element; if \ref SEL_FLAGSSET
 339  * is set for an element, the function returns immediately, and the recursive
 340  * operation does not descend beyond such elements.
 341  */
 342 void
 343 _gmx_selelem_update_flags(const gmx::SelectionTreeElementPointer &sel)
 344 {
 345     bool                bUseChildType = false;
 346     bool                bOnlySingleChildren;
 347
 348     /* Return if the flags have already been set */
 349     if (sel->flags & SEL_FLAGSSET)
 350     {
 351         return;
 352     }
 353     /* Set the flags based on the current element type */
 354     switch (sel->type)
 355     {
 356         case SEL_CONST:
 357         case SEL_GROUPREF:
 358             sel->flags   |= SEL_SINGLEVAL;
 359             bUseChildType = false;
 360             break;
 361
 362         case SEL_EXPRESSION:
 363             if (sel->u.expr.method->flags & SMETH_DYNAMIC)
 364             {
 365                 sel->flags |= SEL_DYNAMIC;
 366             }
 367             if (sel->u.expr.method->flags & SMETH_SINGLEVAL)
 368             {
 369                 sel->flags |= SEL_SINGLEVAL;
 370             }
 371             else if (sel->u.expr.method->flags & SMETH_VARNUMVAL)
 372             {
 373                 sel->flags |= SEL_VARNUMVAL;
 374             }
 375             else
 376             {
 377                 sel->flags |= SEL_ATOMVAL;
 378             }
 379             bUseChildType = false;
 380             break;
 381
 382         case SEL_ARITHMETIC:
 383             sel->flags   |= SEL_ATOMVAL;
 384             bUseChildType = false;
 385             break;
 386
 387         case SEL_MODIFIER:
 388             if (sel->v.type != NO_VALUE)
 389             {
 390                 sel->flags |= SEL_VARNUMVAL;
 391             }
 392             bUseChildType = false;
 393             break;
 394
 395         case SEL_ROOT:
 396             bUseChildType = false;
 397             break;
 398
 399         case SEL_BOOLEAN:
 400         case SEL_SUBEXPR:
 401         case SEL_SUBEXPRREF:
 402             bUseChildType = true;
 403             break;
 404     }
 405     /* Loop through children to propagate their flags upwards */
 406     bOnlySingleChildren = true;
 407     SelectionTreeElementPointer child = sel->child;
 408     while (child)
 409     {
 410         /* Update the child */
 411         _gmx_selelem_update_flags(child);
 412         /* Propagate the dynamic and unsorted flags */
 413         sel->flags |= (child->flags & (SEL_DYNAMIC | SEL_UNSORTED));
 414         /* Propagate the type flag if necessary and check for problems */
 415         if (bUseChildType)
 416         {
 417             if ((sel->flags & SEL_VALTYPEMASK)
 418                 && !(sel->flags & child->flags & SEL_VALTYPEMASK))
 419             {
 420                 // TODO: Recollect when this is triggered, and whether the type
 421                 // is appropriate.
 422                 GMX_THROW(gmx::InvalidInputError("Invalid combination of selection expressions"));
 423             }
 424             sel->flags |= (child->flags & SEL_VALTYPEMASK);
 425         }
 426         if (!(child->flags & SEL_SINGLEVAL))
 427         {
 428             bOnlySingleChildren = false;
 429         }
 430
 431         child = child->next;
 432     }
 433     /* For arithmetic expressions consisting only of single values,
 434      * the result is also a single value. */
 435     if (sel->type == SEL_ARITHMETIC && bOnlySingleChildren)
 436     {
 437         sel->flags = (sel->flags & ~SEL_VALTYPEMASK) | SEL_SINGLEVAL;
 438     }
 439     /* For root elements, the type should be propagated here, after the
 440      * children have been updated. */
 441     if (sel->type == SEL_ROOT)
 442     {
 443         GMX_ASSERT(sel->child, "Root elements should always have a child");
 444         sel->flags |= (sel->child->flags & SEL_VALTYPEMASK);
 445     }
 446     /* Mark that the flags are set */
 447     sel->flags |= SEL_FLAGSSET;
 448 }
 449
 450 /*!
 451  * \param[in,out] sel    Selection element to initialize.
 452  * \param[in]     scanner Scanner data structure.
 453  *
 454  * A deep copy of the parameters is made to allow several
 455  * expressions with the same method to coexist peacefully.
 456  * Calls sel_datafunc() if one is specified for the method.
 457  */
 458 void
 459 _gmx_selelem_init_method_params(const gmx::SelectionTreeElementPointer &sel,
 460                                 yyscan_t                                scanner)
 461 {
 462     int                 nparams;
 463     gmx_ana_selparam_t *orgparam;
 464     gmx_ana_selparam_t *param;
 465     int                 i;
 466     void               *mdata;
 467
 468     nparams   = sel->u.expr.method->nparams;
 469     orgparam  = sel->u.expr.method->param;
 470     snew(param, nparams);
 471     memcpy(param, orgparam, nparams*sizeof(gmx_ana_selparam_t));
 472     for (i = 0; i < nparams; ++i)
 473     {
 474         param[i].flags &= ~SPAR_SET;
 475         _gmx_selvalue_setstore(&param[i].val, NULL);
 476         if (param[i].flags & SPAR_VARNUM)
 477         {
 478             param[i].val.nr = -1;
 479         }
 480         /* Duplicate the enum value array if it is given statically */
 481         if ((param[i].flags & SPAR_ENUMVAL) && orgparam[i].val.u.ptr != NULL)
 482         {
 483             int n;
 484
 485             /* Count the values */
 486             n = 1;
 487             while (orgparam[i].val.u.s[n] != NULL)
 488             {
 489                 ++n;
 490             }
 491             _gmx_selvalue_reserve(&param[i].val, n+1);
 492             memcpy(param[i].val.u.s, orgparam[i].val.u.s,
 493                    (n+1)*sizeof(param[i].val.u.s[0]));
 494         }
 495     }
 496     mdata = NULL;
 497     if (sel->u.expr.method->init_data)
 498     {
 499         mdata = sel->u.expr.method->init_data(nparams, param);
 500     }
 501     if (sel->u.expr.method->set_poscoll)
 502     {
 503         gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
 504
 505         sel->u.expr.method->set_poscoll(&sc->pcc, mdata);
 506     }
 507     /* Store the values */
 508     sel->u.expr.method->param = param;
 509     sel->u.expr.mdata         = mdata;
 510 }
 511
 512 /*!
 513  * \param[in,out] sel    Selection element to initialize.
 514  * \param[in]     method Selection method to set.
 515  * \param[in]     scanner Scanner data structure.
 516  *
 517  * Makes a copy of \p method and stores it in \p sel->u.expr.method,
 518  * and calls _gmx_selelem_init_method_params();
 519  */
 520 void
 521 _gmx_selelem_set_method(const gmx::SelectionTreeElementPointer &sel,
 522                         gmx_ana_selmethod_t                    *method,
 523                         yyscan_t                                scanner)
 524 {
 525     _gmx_selelem_set_vtype(sel, method->type);
 526     sel->setName(method->name);
 527     snew(sel->u.expr.method, 1);
 528     memcpy(sel->u.expr.method, method, sizeof(gmx_ana_selmethod_t));
 529     _gmx_selelem_init_method_params(sel, scanner);
 530 }
 531
 532 /*! \brief
 533  * Initializes the reference position calculation for a \ref SEL_EXPRESSION
 534  * element.
 535  *
 536  * \param[in,out] pcc    Position calculation collection to use.
 537  * \param[in,out] sel    Selection element to initialize.
 538  * \param[in]     rpost  Reference position type to use (NULL = default).
 539  * \param[in]     scanner Scanner data structure.
 540  * \returns       0 on success, a non-zero error code on error.
 541  */
 542 static void
 543 set_refpos_type(gmx::PositionCalculationCollection *pcc,
 544                 const SelectionTreeElementPointer &sel,
 545                 const char *rpost, yyscan_t scanner)
 546 {
 547     if (!rpost)
 548     {
 549         return;
 550     }
 551
 552     if (sel->u.expr.method->pupdate)
 553     {
 554         /* By default, use whole residues/molecules. */
 555         sel->u.expr.pc
 556             = pcc->createCalculationFromEnum(rpost, POS_COMPLWHOLE);
 557     }
 558     else
 559     {
 560         // TODO: Should this be treated as a real error?
 561         _gmx_selparser_error(scanner, "modifier '%s' is not applicable for '%s'",
 562                              rpost, sel->u.expr.method->name);
 563     }
 564 }
 565
 566 gmx::SelectionTreeElementPointer
 567 _gmx_sel_init_arithmetic(const gmx::SelectionTreeElementPointer &left,
 568                          const gmx::SelectionTreeElementPointer &right,
 569                          char op, yyscan_t /* scanner */)
 570 {
 571     SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_ARITHMETIC));
 572     sel->v.type        = REAL_VALUE;
 573     switch (op)
 574     {
 575         case '+': sel->u.arith.type = ARITH_PLUS; break;
 576         case '-': sel->u.arith.type = (right ? ARITH_MINUS : ARITH_NEG); break;
 577         case '*': sel->u.arith.type = ARITH_MULT; break;
 578         case '/': sel->u.arith.type = ARITH_DIV;  break;
 579         case '^': sel->u.arith.type = ARITH_EXP;  break;
 580     }
 581     char               buf[2];
 582     buf[0] = op;
 583     buf[1] = 0;
 584     sel->setName(buf);
 585     sel->u.arith.opstr = gmx_strdup(buf);
 586     sel->child         = left;
 587     sel->child->next   = right;
 588     return sel;
 589 }
 590
 591 /*!
 592  * \param[in]  left   Selection element for the left hand side.
 593  * \param[in]  right  Selection element for the right hand side.
 594  * \param[in]  cmpop  String representation of the comparison operator.
 595  * \param[in]  scanner Scanner data structure.
 596  * \returns    The created selection element.
 597  *
 598  * This function handles the creation of a gmx::SelectionTreeElement object for
 599  * comparison expressions.
 600  */
 601 SelectionTreeElementPointer
 602 _gmx_sel_init_comparison(const gmx::SelectionTreeElementPointer &left,
 603                          const gmx::SelectionTreeElementPointer &right,
 604                          const char *cmpop, yyscan_t scanner)
 605 {
 606     gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
 607     gmx::MessageStringContext    context(errors, "In comparison initialization");
 608
 609     SelectionTreeElementPointer  sel(new SelectionTreeElement(SEL_EXPRESSION));
 610     _gmx_selelem_set_method(sel, &sm_compare, scanner);
 611
 612     SelectionParserParameterList params;
 613     const char                  *name;
 614     // Create the parameter for the left expression.
 615     name  = left->v.type == INT_VALUE ? "int1" : "real1";
 616     params.push_back(SelectionParserParameter::createFromExpression(name, left));
 617     // Create the parameter for the right expression.
 618     name  = right->v.type == INT_VALUE ? "int2" : "real2";
 619     params.push_back(SelectionParserParameter::createFromExpression(name, right));
 620     // Create the parameter for the operator.
 621     params.push_back(
 622             SelectionParserParameter::create(
 623                     "op", SelectionParserValue::createString(cmpop)));
 624     if (!_gmx_sel_parse_params(params, sel->u.expr.method->nparams,
 625                                sel->u.expr.method->param, sel, scanner))
 626     {
 627         return SelectionTreeElementPointer();
 628     }
 629
 630     return sel;
 631 }
 632
 633 /*! \brief
 634  * Implementation method for keyword expression creation.
 635  *
 636  * \param[in]  method Method to use.
 637  * \param[in]  matchType String matching type (only used if \p method is
 638  *      a string keyword and \p args is not empty.
 639  * \param[in]  args   Pointer to the first argument.
 640  * \param[in]  rpost  Reference position type to use (NULL = default).
 641  * \param[in]  scanner Scanner data structure.
 642  * \returns    The created selection element.
 643  *
 644  * This function handles the creation of a gmx::SelectionTreeElement object for
 645  * selection methods that do not take parameters.
 646  */
 647 static SelectionTreeElementPointer
 648 init_keyword_internal(gmx_ana_selmethod_t *method,
 649                       gmx::SelectionStringMatchType matchType,
 650                       SelectionParserValueListPointer args,
 651                       const char *rpost, yyscan_t scanner)
 652 {
 653     gmx_ana_selcollection_t     *sc = _gmx_sel_lexer_selcollection(scanner);
 654
 655     gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
 656     char  buf[128];
 657     sprintf(buf, "In keyword '%s'", method->name);
 658     gmx::MessageStringContext  context(errors, buf);
 659
 660     if (method->nparams > 0)
 661     {
 662         // TODO: Would assert be better?
 663         GMX_THROW(gmx::InternalError(
 664                           "Keyword initialization called with non-keyword method"));
 665     }
 666
 667     SelectionTreeElementPointer root(new SelectionTreeElement(SEL_EXPRESSION));
 668     SelectionTreeElementPointer child = root;
 669     _gmx_selelem_set_method(child, method, scanner);
 670
 671     /* Initialize the evaluation of keyword matching if values are provided */
 672     if (args)
 673     {
 674         gmx_ana_selmethod_t *kwmethod;
 675         switch (method->type)
 676         {
 677             case INT_VALUE:  kwmethod = &sm_keyword_int;  break;
 678             case REAL_VALUE: kwmethod = &sm_keyword_real; break;
 679             case STR_VALUE:  kwmethod = &sm_keyword_str;  break;
 680             default:
 681                 GMX_THROW(gmx::InternalError(
 682                                   "Unknown type for keyword selection"));
 683         }
 684         /* Initialize the selection element */
 685         root.reset(new SelectionTreeElement(SEL_EXPRESSION));
 686         _gmx_selelem_set_method(root, kwmethod, scanner);
 687         if (method->type == STR_VALUE)
 688         {
 689             _gmx_selelem_set_kwstr_match_type(root, matchType);
 690         }
 691         SelectionParserParameterList params;
 692         params.push_back(
 693                 SelectionParserParameter::createFromExpression(NULL, child));
 694         params.push_back(SelectionParserParameter::create(NULL, move(args)));
 695         if (!_gmx_sel_parse_params(params, root->u.expr.method->nparams,
 696                                    root->u.expr.method->param, root, scanner))
 697         {
 698             return SelectionTreeElementPointer();
 699         }
 700     }
 701     set_refpos_type(&sc->pcc, child, rpost, scanner);
 702
 703     return root;
 704 }
 705
 706 /*!
 707  * \param[in]  method Method to use.
 708  * \param[in]  args   Pointer to the first argument.
 709  * \param[in]  rpost  Reference position type to use (NULL = default).
 710  * \param[in]  scanner Scanner data structure.
 711  * \returns    The created selection element.
 712  *
 713  * This function handles the creation of a gmx::SelectionTreeElement object for
 714  * selection methods that do not take parameters.
 715  */
 716 SelectionTreeElementPointer
 717 _gmx_sel_init_keyword(gmx_ana_selmethod_t *method,
 718                       gmx::SelectionParserValueListPointer args,
 719                       const char *rpost, yyscan_t scanner)
 720 {
 721     return init_keyword_internal(method, gmx::eStringMatchType_Auto, move(args),
 722                                  rpost, scanner);
 723 }
 724
 725 /*!
 726  * \param[in]  method    Method to use.
 727  * \param[in]  matchType String matching type.
 728  * \param[in]  args      Pointer to the first argument.
 729  * \param[in]  rpost     Reference position type to use (NULL = default).
 730  * \param[in]  scanner   Scanner data structure.
 731  * \returns    The created selection element.
 732  *
 733  * This function handles the creation of a gmx::SelectionTreeElement object for
 734  * keyword string matching.
 735  */
 736 SelectionTreeElementPointer
 737 _gmx_sel_init_keyword_strmatch(gmx_ana_selmethod_t *method,
 738                                gmx::SelectionStringMatchType matchType,
 739                                gmx::SelectionParserValueListPointer args,
 740                                const char *rpost, yyscan_t scanner)
 741 {
 742     GMX_RELEASE_ASSERT(method->type == STR_VALUE,
 743                        "String keyword method called for a non-string-valued method");
 744     GMX_RELEASE_ASSERT(args && !args->empty(),
 745                        "String keyword matching method called without any values");
 746     return init_keyword_internal(method, matchType, move(args), rpost, scanner);
 747 }
 748
 749 /*!
 750  * \param[in]  method Method to use for initialization.
 751  * \param[in]  group  Selection in which the keyword should be evaluated.
 752  * \param[in]  rpost  Reference position type to use (NULL = default).
 753  * \param[in]  scanner Scanner data structure.
 754  * \returns    The created selection element.
 755  *
 756  * This function handles the creation of a gmx::SelectionTreeElement object for
 757  * expressions like "z of ...".
 758  */
 759 SelectionTreeElementPointer
 760 _gmx_sel_init_keyword_of(gmx_ana_selmethod_t                    *method,
 761                          const gmx::SelectionTreeElementPointer &group,
 762                          const char *rpost, yyscan_t scanner)
 763 {
 764     gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
 765     char  buf[128];
 766     sprintf(buf, "In '%s of'", method->name);
 767     gmx::MessageStringContext    context(errors, buf);
 768
 769     GMX_UNUSED_VALUE(rpost);
 770     return _gmx_sel_init_keyword_evaluator(method, group, scanner);
 771 }
 772
 773 /*!
 774  * \param[in]  method Method to use for initialization.
 775  * \param[in]  params Pointer to the first parameter.
 776  * \param[in]  rpost  Reference position type to use (NULL = default).
 777  * \param[in]  scanner Scanner data structure.
 778  * \returns    The created selection element.
 779  *
 780  * This function handles the creation of a gmx::SelectionTreeElement object for
 781  * selection methods that take parameters.
 782  *
 783  * Part of the behavior of the \c same selection keyword is hardcoded into
 784  * this function (or rather, into _gmx_selelem_custom_init_same()) to allow the
 785  * use of any keyword in \c "same KEYWORD as" without requiring special
 786  * handling somewhere else (or sacrificing the simple syntax).
 787  */
 788 SelectionTreeElementPointer
 789 _gmx_sel_init_method(gmx_ana_selmethod_t                      *method,
 790                      gmx::SelectionParserParameterListPointer  params,
 791                      const char *rpost, yyscan_t scanner)
 792 {
 793     gmx_ana_selcollection_t     *sc = _gmx_sel_lexer_selcollection(scanner);
 794     int                          rc;
 795
 796     gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
 797     char  buf[128];
 798     sprintf(buf, "In keyword '%s'", method->name);
 799     gmx::MessageStringContext  context(errors, buf);
 800
 801     _gmx_sel_finish_method(scanner);
 802     /* The "same" keyword needs some custom massaging of the parameters. */
 803     rc = _gmx_selelem_custom_init_same(&method, params, scanner);
 804     if (rc != 0)
 805     {
 806         return SelectionTreeElementPointer();
 807     }
 808     SelectionTreeElementPointer root(new SelectionTreeElement(SEL_EXPRESSION));
 809     _gmx_selelem_set_method(root, method, scanner);
 810     /* Process the parameters */
 811     if (!_gmx_sel_parse_params(*params, root->u.expr.method->nparams,
 812                                root->u.expr.method->param, root, scanner))
 813     {
 814         return SelectionTreeElementPointer();
 815     }
 816     set_refpos_type(&sc->pcc, root, rpost, scanner);
 817
 818     return root;
 819 }
 820
 821 /*!
 822  * \param[in]  method Modifier to use for initialization.
 823  * \param[in]  params Pointer to the first parameter.
 824  * \param[in]  sel    Selection element that the modifier should act on.
 825  * \param[in]  scanner Scanner data structure.
 826  * \returns    The created selection element.
 827  *
 828  * This function handles the creation of a gmx::SelectionTreeElement object for
 829  * selection modifiers.
 830  */
 831 SelectionTreeElementPointer
 832 _gmx_sel_init_modifier(gmx_ana_selmethod_t                      *method,
 833                        gmx::SelectionParserParameterListPointer  params,
 834                        const gmx::SelectionTreeElementPointer   &sel,
 835                        yyscan_t                                  scanner)
 836 {
 837     gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
 838     char  buf[128];
 839     sprintf(buf, "In keyword '%s'", method->name);
 840     gmx::MessageStringContext  context(errors, buf);
 841
 842     _gmx_sel_finish_method(scanner);
 843     SelectionTreeElementPointer modifier(new SelectionTreeElement(SEL_MODIFIER));
 844     _gmx_selelem_set_method(modifier, method, scanner);
 845     SelectionTreeElementPointer root;
 846     if (method->type == NO_VALUE)
 847     {
 848         SelectionTreeElementPointer child = sel;
 849         while (child->next)
 850         {
 851             child = child->next;
 852         }
 853         child->next = modifier;
 854         root        = sel;
 855     }
 856     else
 857     {
 858         params->push_front(
 859                 SelectionParserParameter::createFromExpression(NULL, sel));
 860         root = modifier;
 861     }
 862     /* Process the parameters */
 863     if (!_gmx_sel_parse_params(*params, modifier->u.expr.method->nparams,
 864                                modifier->u.expr.method->param, modifier, scanner))
 865     {
 866         return SelectionTreeElementPointer();
 867     }
 868
 869     return root;
 870 }
 871
 872 /*!
 873  * \param[in]  expr    Input selection element for the position calculation.
 874  * \param[in]  type    Reference position type or NULL for default.
 875  * \param[in]  scanner Scanner data structure.
 876  * \returns    The created selection element.
 877  *
 878  * This function handles the creation of a gmx::SelectionTreeElement object for
 879  * evaluation of reference positions.
 880  */
 881 SelectionTreeElementPointer
 882 _gmx_sel_init_position(const gmx::SelectionTreeElementPointer &expr,
 883                        const char *type, yyscan_t scanner)
 884 {
 885     gmx::MessageStringCollector *errors = _gmx_sel_lexer_error_reporter(scanner);
 886     char  buf[128];
 887     sprintf(buf, "In position evaluation");
 888     gmx::MessageStringContext   context(errors, buf);
 889
 890     SelectionTreeElementPointer root(new SelectionTreeElement(SEL_EXPRESSION));
 891     _gmx_selelem_set_method(root, &sm_keyword_pos, scanner);
 892     _gmx_selelem_set_kwpos_type(root.get(), type);
 893     /* Create the parameters for the parameter parser. */
 894     SelectionParserParameterList params;
 895     params.push_back(SelectionParserParameter::createFromExpression(NULL, expr));
 896     /* Parse the parameters. */
 897     if (!_gmx_sel_parse_params(params, root->u.expr.method->nparams,
 898                                root->u.expr.method->param, root, scanner))
 899     {
 900         return SelectionTreeElementPointer();
 901     }
 902
 903     return root;
 904 }
 905
 906 /*!
 907  * \param[in] x,y,z  Coordinates for the position.
 908  * \returns   The creates selection element.
 909  */
 910 SelectionTreeElementPointer
 911 _gmx_sel_init_const_position(real x, real y, real z)
 912 {
 913     rvec                        pos;
 914
 915     SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_CONST));
 916     _gmx_selelem_set_vtype(sel, POS_VALUE);
 917     _gmx_selvalue_reserve(&sel->v, 1);
 918     pos[XX] = x;
 919     pos[YY] = y;
 920     pos[ZZ] = z;
 921     gmx_ana_pos_init_const(sel->v.u.p, pos);
 922     return sel;
 923 }
 924
 925 /*!
 926  * \param[in] name  Name of an index group to search for.
 927  * \param[in] scanner Scanner data structure.
 928  * \returns   The created selection element.
 929  *
 930  * See gmx_ana_indexgrps_find() for information on how \p name is matched
 931  * against the index groups.
 932  */
 933 SelectionTreeElementPointer
 934 _gmx_sel_init_group_by_name(const char *name, yyscan_t scanner)
 935 {
 936
 937     SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_GROUPREF));
 938     _gmx_selelem_set_vtype(sel, GROUP_VALUE);
 939     sel->setName(gmx::formatString("group \"%s\"", name));
 940     sel->u.gref.name = gmx_strdup(name);
 941     sel->u.gref.id   = -1;
 942
 943     if (_gmx_sel_lexer_has_groups_set(scanner))
 944     {
 945         gmx_ana_indexgrps_t     *grps = _gmx_sel_lexer_indexgrps(scanner);
 946         gmx_ana_selcollection_t *sc   = _gmx_sel_lexer_selcollection(scanner);
 947         sel->resolveIndexGroupReference(grps, sc->gall.isize);
 948     }
 949
 950     return sel;
 951 }
 952
 953 /*!
 954  * \param[in] id    Zero-based index number of the group to extract.
 955  * \param[in] scanner Scanner data structure.
 956  * \returns   The created selection element.
 957  */
 958 SelectionTreeElementPointer
 959 _gmx_sel_init_group_by_id(int id, yyscan_t scanner)
 960 {
 961     SelectionTreeElementPointer sel(new SelectionTreeElement(SEL_GROUPREF));
 962     _gmx_selelem_set_vtype(sel, GROUP_VALUE);
 963     sel->setName(gmx::formatString("group %d", id));
 964     sel->u.gref.name = NULL;
 965     sel->u.gref.id   = id;
 966
 967     if (_gmx_sel_lexer_has_groups_set(scanner))
 968     {
 969         gmx_ana_indexgrps_t     *grps = _gmx_sel_lexer_indexgrps(scanner);
 970         gmx_ana_selcollection_t *sc   = _gmx_sel_lexer_selcollection(scanner);
 971         sel->resolveIndexGroupReference(grps, sc->gall.isize);
 972     }
 973
 974     return sel;
 975 }
 976
 977 /*!
 978  * \param[in,out] sel  Value of the variable.
 979  * \returns       The created selection element that references \p sel.
 980  *
 981  * The reference count of \p sel is updated, but no other modifications are
 982  * made.
 983  */
 984 SelectionTreeElementPointer
 985 _gmx_sel_init_variable_ref(const gmx::SelectionTreeElementPointer &sel)
 986 {
 987     SelectionTreeElementPointer ref;
 988
 989     if (sel->v.type == POS_VALUE && sel->type == SEL_CONST)
 990     {
 991         ref = sel;
 992     }
 993     else
 994     {
 995         ref.reset(new SelectionTreeElement(SEL_SUBEXPRREF));
 996         _gmx_selelem_set_vtype(ref, sel->v.type);
 997         ref->setName(sel->name());
 998         ref->child = sel;
 999     }
1000     return ref;
1001 }
1002
1003 /*!
1004  * \param[in]  name     Name for the selection
1005  *     (if NULL, a default name is constructed).
1006  * \param[in]  sel      The selection element that evaluates the selection.
1007  * \param      scanner  Scanner data structure.
1008  * \returns    The created root selection element.
1009  *
1010  * This function handles the creation of root (\ref SEL_ROOT)
1011  * gmx::SelectionTreeElement objects for selections.
1012  */
1013 SelectionTreeElementPointer
1014 _gmx_sel_init_selection(const char                             *name,
1015                         const gmx::SelectionTreeElementPointer &sel,
1016                         yyscan_t                                scanner)
1017 {
1018     if (sel->v.type != POS_VALUE)
1019     {
1020         /* FIXME: Better handling of this error */
1021         GMX_THROW(gmx::InternalError(
1022                           "Each selection must evaluate to a position"));
1023     }
1024
1025     SelectionTreeElementPointer root(new SelectionTreeElement(SEL_ROOT));
1026     root->child = sel;
1027     if (name)
1028     {
1029         root->setName(name);
1030     }
1031     /* Update the flags */
1032     _gmx_selelem_update_flags(root);
1033     gmx::ExceptionInitializer errors("Invalid index group reference(s)");
1034     root->checkUnsortedAtoms(true, &errors);
1035     if (errors.hasNestedExceptions())
1036     {
1037         GMX_THROW(gmx::InconsistentInputError(errors));
1038     }
1039
1040     root->fillNameIfMissing(_gmx_sel_lexer_pselstr(scanner));
1041
1042     /* Print out some information if the parser is interactive */
1043     if (_gmx_sel_is_lexer_interactive(scanner))
1044     {
1045         fprintf(stderr, "Selection '%s' parsed\n",
1046                 _gmx_sel_lexer_pselstr(scanner));
1047     }
1048
1049     return root;
1050 }
1051
1052
1053 /*!
1054  * \param[in]  name     Name of the variable.
1055  * \param[in]  expr     The selection element that evaluates the variable.
1056  * \param      scanner  Scanner data structure.
1057  * \returns    The created root selection element.
1058  *
1059  * This function handles the creation of root gmx::SelectionTreeElement objects
1060  * for variable assignments. A \ref SEL_ROOT element and a \ref SEL_SUBEXPR
1061  * element are both created.
1062  */
1063 SelectionTreeElementPointer
1064 _gmx_sel_assign_variable(const char                             *name,
1065                          const gmx::SelectionTreeElementPointer &expr,
1066                          yyscan_t                                scanner)
1067 {
1068     gmx_ana_selcollection_t     *sc      = _gmx_sel_lexer_selcollection(scanner);
1069     const char                  *pselstr = _gmx_sel_lexer_pselstr(scanner);
1070     SelectionTreeElementPointer  root;
1071
1072     _gmx_selelem_update_flags(expr);
1073     /* Check if this is a constant non-group value */
1074     if (expr->type == SEL_CONST && expr->v.type != GROUP_VALUE)
1075     {
1076         /* If so, just assign the constant value to the variable */
1077         sc->symtab->addVariable(name, expr);
1078     }
1079     /* Check if we are assigning a variable to another variable */
1080     else if (expr->type == SEL_SUBEXPRREF)
1081     {
1082         /* If so, make a simple alias */
1083         sc->symtab->addVariable(name, expr->child);
1084     }
1085     else
1086     {
1087         /* Create the root element */
1088         root.reset(new SelectionTreeElement(SEL_ROOT));
1089         root->setName(name);
1090         /* Create the subexpression element */
1091         root->child.reset(new SelectionTreeElement(SEL_SUBEXPR));
1092         root->child->setName(name);
1093         _gmx_selelem_set_vtype(root->child, expr->v.type);
1094         root->child->child  = expr;
1095         /* Update flags */
1096         _gmx_selelem_update_flags(root);
1097         gmx::ExceptionInitializer errors("Invalid index group reference(s)");
1098         root->checkUnsortedAtoms(true, &errors);
1099         if (errors.hasNestedExceptions())
1100         {
1101             GMX_THROW(gmx::InconsistentInputError(errors));
1102         }
1103         /* Add the variable to the symbol table */
1104         sc->symtab->addVariable(name, root->child);
1105     }
1106     srenew(sc->varstrs, sc->nvars + 1);
1107     sc->varstrs[sc->nvars] = gmx_strdup(pselstr);
1108     ++sc->nvars;
1109     if (_gmx_sel_is_lexer_interactive(scanner))
1110     {
1111         fprintf(stderr, "Variable '%s' parsed\n", pselstr);
1112     }
1113     return root;
1114 }
1115
1116 /*!
1117  * \param         sel   Selection to append (can be NULL, in which
1118  *   case nothing is done).
1119  * \param         last  Last selection, or NULL if not present or not known.
1120  * \param         scanner  Scanner data structure.
1121  * \returns       The last selection after the append.
1122  *
1123  * Appends \p sel after the last root element, and returns either \p sel
1124  * (if it was non-NULL) or the last element (if \p sel was NULL).
1125  */
1126 SelectionTreeElementPointer
1127 _gmx_sel_append_selection(const gmx::SelectionTreeElementPointer &sel,
1128                           gmx::SelectionTreeElementPointer        last,
1129                           yyscan_t                                scanner)
1130 {
1131     gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
1132
1133     /* Append sel after last, or the last element of sc if last is NULL */
1134     if (last)
1135     {
1136         last->next = sel;
1137     }
1138     else
1139     {
1140         if (sc->root)
1141         {
1142             last = sc->root;
1143             while (last->next)
1144             {
1145                 last = last->next;
1146             }
1147             last->next = sel;
1148         }
1149         else
1150         {
1151             sc->root = sel;
1152         }
1153     }
1154     /* Initialize a selection object if necessary */
1155     if (sel)
1156     {
1157         last = sel;
1158         /* Add the new selection to the collection if it is not a variable. */
1159         if (sel->child->type != SEL_SUBEXPR)
1160         {
1161             gmx::SelectionDataPointer selPtr(
1162                     new gmx::internal::SelectionData(
1163                             sel.get(), _gmx_sel_lexer_pselstr(scanner)));
1164             sc->sel.push_back(gmx::move(selPtr));
1165         }
1166     }
1167     /* Clear the selection string now that we've saved it */
1168     _gmx_sel_lexer_clear_pselstr(scanner);
1169     return last;
1170 }
1171
1172 /*!
1173  * \param[in] scanner Scanner data structure.
1174  * \returns   true if the parser should finish, false if parsing should
1175  *   continue.
1176  *
1177  * This function is called always after _gmx_sel_append_selection() to
1178  * check whether a sufficient number of selections has already been provided.
1179  * This is used to terminate interactive parsers when the correct number of
1180  * selections has been provided.
1181  */
1182 bool
1183 _gmx_sel_parser_should_finish(yyscan_t scanner)
1184 {
1185     gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
1186     return (int)sc->sel.size() == _gmx_sel_lexer_exp_selcount(scanner);
1187 }