2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
37 * Implements gmx::SelectionCollection.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_selection
44 #include "selectioncollection.h"
52 #include <boost/shared_ptr.hpp>
54 #include "gromacs/fileio/trx.h"
55 #include "gromacs/legacyheaders/oenv.h"
56 #include "gromacs/onlinehelp/helpmanager.h"
57 #include "gromacs/onlinehelp/helpwritercontext.h"
58 #include "gromacs/options/basicoptions.h"
59 #include "gromacs/options/options.h"
60 #include "gromacs/selection/selection.h"
61 #include "gromacs/selection/selhelp.h"
62 #include "gromacs/topology/topology.h"
63 #include "gromacs/utility/exceptions.h"
64 #include "gromacs/utility/file.h"
65 #include "gromacs/utility/gmxassert.h"
66 #include "gromacs/utility/messagestringcollector.h"
67 #include "gromacs/utility/smalloc.h"
68 #include "gromacs/utility/stringutil.h"
75 #include "selectioncollection-impl.h"
77 #include "selmethod.h"
83 /********************************************************************
84 * SelectionCollection::Impl
87 SelectionCollection::Impl::Impl()
88 : maxAtomIndex_(0), debugLevel_(0), bExternalGroupsSet_(false), grps_(NULL)
93 gmx_ana_index_clear(&sc_.gall);
95 sc_.symtab.reset(new SelectionParserSymbolTable);
96 gmx_ana_selmethod_register_defaults(sc_.symtab.get());
100 SelectionCollection::Impl::~Impl()
103 // The tree must be freed before the SelectionData objects, since the
104 // tree may hold references to the position data in SelectionData.
107 for (int i = 0; i < sc_.nvars; ++i)
109 sfree(sc_.varstrs[i]);
112 gmx_ana_index_deinit(&sc_.gall);
115 _gmx_sel_mempool_destroy(sc_.mempool);
121 SelectionCollection::Impl::clearSymbolTable()
131 * Reads a single selection line from stdin.
133 * \param[in] infile File to read from (typically File::standardInput()).
134 * \param[in] bInteractive Whether to print interactive prompts.
135 * \param[out] line The read line in stored here.
136 * \returns true if something was read, false if at end of input.
138 * Handles line continuation, reading also the continuing line(s) in one call.
140 bool promptLine(File *infile, bool bInteractive, std::string *line)
144 fprintf(stderr, "> ");
146 if (!infile->readLineWithTrailingSpace(line))
150 while (endsWith(*line, "\\\n"))
152 line->resize(line->length() - 2);
155 fprintf(stderr, "... ");
158 // Return value ignored, buffer remains empty and works correctly
159 // if there is nothing to read.
160 infile->readLineWithTrailingSpace(&buffer);
161 line->append(buffer);
163 if (endsWith(*line, "\n"))
165 line->resize(line->length() - 1);
167 else if (bInteractive)
169 fprintf(stderr, "\n");
175 * Helper function for tokenizing the input and pushing them to the parser.
177 * \param scanner Tokenizer data structure.
178 * \param parserState Parser data structure.
179 * \param[in] bInteractive Whether to operate in interactive mode.
181 * Repeatedly reads tokens using \p scanner and pushes them to the parser with
182 * \p parserState until there is no more input, or until enough input is given
183 * (only in interactive mode).
185 int runParserLoop(yyscan_t scanner, _gmx_sel_yypstate *parserState,
188 int status = YYPUSH_MORE;
193 int token = _gmx_sel_yylex(&value, scanner);
200 // Empty commands cause the interactive parser to print out
201 // status information. This avoids producing those unnecessarily,
202 // e.g., from "resname RA;;".
203 if (prevToken == CMD_SEP && token == CMD_SEP)
209 status = _gmx_sel_yypush_parse(parserState, token, &value, scanner);
211 while (status == YYPUSH_MORE);
212 _gmx_sel_lexer_rethrow_exception_if_occurred(scanner);
217 * Print current status in response to empty line in interactive input.
219 * \param[in] sc Selection collection data structure.
220 * \param[in] grps Available index groups.
221 * \param[in] firstSelection Index of first selection from this interactive
223 * \param[in] maxCount Maximum number of selections.
224 * \param[in] context Context to print for what the selections are for.
225 * \param[in] bFirst Whether this is the header that is printed before
228 * Prints the available index groups and currently provided selections.
230 void printCurrentStatus(gmx_ana_selcollection_t *sc, gmx_ana_indexgrps_t *grps,
231 size_t firstSelection, int maxCount,
232 const std::string &context, bool bFirst)
236 std::fprintf(stderr, "Available static index groups:\n");
237 gmx_ana_indexgrps_print(stderr, grps, 0);
239 std::fprintf(stderr, "Specify ");
242 std::fprintf(stderr, "any number of selections");
244 else if (maxCount == 1)
246 std::fprintf(stderr, "a selection");
250 std::fprintf(stderr, "%d selections", maxCount);
252 std::fprintf(stderr, "%s%s:\n",
253 context.empty() ? "" : " ", context.c_str());
255 "(one per line, <enter> for status/groups, 'help' for help%s)\n",
256 maxCount < 0 ? ", Ctrl-D to end" : "");
257 if (!bFirst && (sc->nvars > 0 || sc->sel.size() > firstSelection))
259 std::fprintf(stderr, "Currently provided selections:\n");
260 for (int i = 0; i < sc->nvars; ++i)
262 std::fprintf(stderr, " %s\n", sc->varstrs[i]);
264 for (size_t i = firstSelection; i < sc->sel.size(); ++i)
266 std::fprintf(stderr, " %2d. %s\n",
267 static_cast<int>(i - firstSelection + 1),
268 sc->sel[i]->selectionText());
273 = maxCount - static_cast<int>(sc->sel.size() - firstSelection);
274 std::fprintf(stderr, "(%d more selection%s required)\n",
275 remaining, remaining > 1 ? "s" : "");
281 * Prints selection help in interactive selection input.
283 * \param[in] sc Selection collection data structure.
284 * \param[in] line Line of user input requesting help (starting with `help`).
286 * Initializes the selection help if not yet initialized, and finds the help
287 * topic based on words on the input line.
289 void printHelp(gmx_ana_selcollection_t *sc, const std::string &line)
291 if (sc->rootHelp.get() == NULL)
293 sc->rootHelp = createSelectionHelpTopic();
295 HelpWriterContext context(&File::standardError(),
296 eHelpOutputFormat_Console);
297 HelpManager manager(*sc->rootHelp, context);
300 std::vector<std::string> topic = splitString(line);
301 std::vector<std::string>::const_iterator value;
302 // First item in the list is the 'help' token.
303 for (value = topic.begin() + 1; value != topic.end(); ++value)
305 manager.enterTopic(*value);
308 catch (const InvalidInputError &ex)
310 fprintf(stderr, "%s\n", ex.what());
313 manager.writeCurrentTopic();
317 * Helper function that runs the parser once the tokenizer has been
320 * \param[in,out] scanner Scanner data structure.
321 * \param[in] bStdIn Whether to use a line-based reading
322 * algorithm designed for interactive input.
323 * \param[in] maxnr Maximum number of selections to parse
324 * (if -1, parse as many as provided by the user).
325 * \param[in] context Context to print for what the selections are for.
326 * \returns Vector of parsed selections.
327 * \throws std::bad_alloc if out of memory.
328 * \throws InvalidInputError if there is a parsing error.
330 * Used internally to implement parseFromStdin(), parseFromFile() and
333 SelectionList runParser(yyscan_t scanner, bool bStdIn, int maxnr,
334 const std::string &context)
336 boost::shared_ptr<void> scannerGuard(scanner, &_gmx_sel_free_lexer);
337 gmx_ana_selcollection_t *sc = _gmx_sel_lexer_selcollection(scanner);
338 gmx_ana_indexgrps_t *grps = _gmx_sel_lexer_indexgrps(scanner);
340 MessageStringCollector errors;
341 _gmx_sel_set_lexer_error_reporter(scanner, &errors);
343 size_t oldCount = sc->sel.size();
346 boost::shared_ptr<_gmx_sel_yypstate> parserState(
347 _gmx_sel_yypstate_new(), &_gmx_sel_yypstate_delete);
350 File &stdinFile(File::standardInput());
351 const bool bInteractive = _gmx_sel_is_lexer_interactive(scanner);
354 printCurrentStatus(sc, grps, oldCount, maxnr, context, true);
358 while (promptLine(&stdinFile, bInteractive, &line))
362 line = stripString(line);
365 printCurrentStatus(sc, grps, oldCount, maxnr, context, false);
368 if (startsWith(line, "help")
369 && (line[4] == 0 || std::isspace(line[4])))
376 _gmx_sel_set_lex_input_str(scanner, line.c_str());
377 status = runParserLoop(scanner, parserState.get(), true);
378 if (status != YYPUSH_MORE)
380 // TODO: Check if there is more input, and issue an
381 // error/warning if some input was ignored.
382 goto early_termination;
384 if (!errors.isEmpty() && bInteractive)
386 fprintf(stderr, "%s", errors.toString().c_str());
390 status = _gmx_sel_yypush_parse(parserState.get(), 0, NULL,
392 _gmx_sel_lexer_rethrow_exception_if_occurred(scanner);
398 int status = runParserLoop(scanner, parserState.get(), false);
402 scannerGuard.reset();
403 int nr = sc->sel.size() - oldCount;
404 if (maxnr > 0 && nr != maxnr)
407 errors.append("Too few selections provided");
410 // TODO: Remove added selections from the collection if parsing failed?
411 if (!bOk || !errors.isEmpty())
413 GMX_ASSERT(!bOk && !errors.isEmpty(), "Inconsistent error reporting");
414 GMX_THROW(InvalidInputError(errors.toString()));
417 SelectionList result;
418 SelectionDataList::const_iterator i;
420 for (i = sc->sel.begin() + oldCount; i != sc->sel.end(); ++i)
422 result.push_back(Selection(i->get()));
428 * Checks that index groups have valid atom indices.
430 * \param[in] root Root of selection tree to process.
431 * \param[in] natoms Maximum number of atoms that the selections are set
433 * \param errors Object for reporting any error messages.
434 * \throws std::bad_alloc if out of memory.
436 * Recursively checks the selection tree for index groups.
437 * Each found group is checked that it only contains atom indices that match
438 * the topology/maximum number of atoms set for the selection collection.
439 * Any issues are reported to \p errors.
441 void checkExternalGroups(const SelectionTreeElementPointer &root,
443 ExceptionInitializer *errors)
445 if (root->type == SEL_CONST && root->v.type == GROUP_VALUE)
449 root->checkIndexGroup(natoms);
451 catch (const UserInputError &)
453 errors->addCurrentExceptionAsNested();
457 SelectionTreeElementPointer child = root->child;
460 checkExternalGroups(child, natoms, errors);
468 void SelectionCollection::Impl::resolveExternalGroups(
469 const SelectionTreeElementPointer &root,
470 ExceptionInitializer *errors)
473 if (root->type == SEL_GROUPREF)
477 root->resolveIndexGroupReference(grps_, sc_.gall.isize);
479 catch (const UserInputError &)
481 errors->addCurrentExceptionAsNested();
485 SelectionTreeElementPointer child = root->child;
488 resolveExternalGroups(child, errors);
489 root->flags |= (child->flags & SEL_UNSORTED);
495 /********************************************************************
496 * SelectionCollection
499 SelectionCollection::SelectionCollection()
505 SelectionCollection::~SelectionCollection()
511 SelectionCollection::initOptions(Options *options)
513 const char * const debug_levels[]
514 = { "no", "basic", "compile", "eval", "full" };
516 bool bAllowNonAtomOutput = false;
517 SelectionDataList::const_iterator iter;
518 for (iter = impl_->sc_.sel.begin(); iter != impl_->sc_.sel.end(); ++iter)
520 const internal::SelectionData &sel = **iter;
521 if (!sel.hasFlag(efSelection_OnlyAtoms))
523 bAllowNonAtomOutput = true;
527 const char *const *postypes = PositionCalculationCollection::typeEnumValues;
528 options->addOption(StringOption("selrpos")
529 .enumValueFromNullTerminatedArray(postypes)
530 .store(&impl_->rpost_).defaultValue(postypes[0])
531 .description("Selection reference positions"));
532 if (bAllowNonAtomOutput)
534 options->addOption(StringOption("seltype")
535 .enumValueFromNullTerminatedArray(postypes)
536 .store(&impl_->spost_).defaultValue(postypes[0])
537 .description("Default selection output positions"));
541 impl_->spost_ = postypes[0];
543 GMX_RELEASE_ASSERT(impl_->debugLevel_ >= 0 && impl_->debugLevel_ <= 4,
544 "Debug level out of range");
545 options->addOption(StringOption("seldebug").hidden(impl_->debugLevel_ == 0)
546 .enumValue(debug_levels)
547 .defaultValue(debug_levels[impl_->debugLevel_])
548 .storeEnumIndex(&impl_->debugLevel_)
549 .description("Print out selection trees for debugging"));
554 SelectionCollection::setReferencePosType(const char *type)
556 GMX_RELEASE_ASSERT(type != NULL, "Cannot assign NULL position type");
557 // Check that the type is valid, throw if it is not.
558 e_poscalc_t dummytype;
560 PositionCalculationCollection::typeFromEnum(type, &dummytype, &dummyflags);
561 impl_->rpost_ = type;
566 SelectionCollection::setOutputPosType(const char *type)
568 GMX_RELEASE_ASSERT(type != NULL, "Cannot assign NULL position type");
569 // Check that the type is valid, throw if it is not.
570 e_poscalc_t dummytype;
572 PositionCalculationCollection::typeFromEnum(type, &dummytype, &dummyflags);
573 impl_->spost_ = type;
578 SelectionCollection::setDebugLevel(int debugLevel)
580 impl_->debugLevel_ = debugLevel;
585 SelectionCollection::setTopology(t_topology *top, int natoms)
587 GMX_RELEASE_ASSERT(natoms > 0 || top != NULL,
588 "The number of atoms must be given if there is no topology");
589 // Get the number of atoms from the topology if it is not given.
592 natoms = top->atoms.nr;
594 if (impl_->bExternalGroupsSet_)
596 ExceptionInitializer errors("Invalid index group references encountered");
597 SelectionTreeElementPointer root = impl_->sc_.root;
600 checkExternalGroups(root, natoms, &errors);
603 if (errors.hasNestedExceptions())
605 GMX_THROW(InconsistentInputError(errors));
608 gmx_ana_selcollection_t *sc = &impl_->sc_;
609 // Do this first, as it allocates memory, while the others don't throw.
610 gmx_ana_index_init_simple(&sc->gall, natoms);
611 sc->pcc.setTopology(top);
617 SelectionCollection::setIndexGroups(gmx_ana_indexgrps_t *grps)
619 GMX_RELEASE_ASSERT(grps == NULL || !impl_->bExternalGroupsSet_,
620 "Can only set external groups once or clear them afterwards");
622 impl_->bExternalGroupsSet_ = true;
624 ExceptionInitializer errors("Invalid index group reference(s)");
625 SelectionTreeElementPointer root = impl_->sc_.root;
628 impl_->resolveExternalGroups(root, &errors);
629 root->checkUnsortedAtoms(true, &errors);
632 if (errors.hasNestedExceptions())
634 GMX_THROW(InconsistentInputError(errors));
636 for (size_t i = 0; i < impl_->sc_.sel.size(); ++i)
638 impl_->sc_.sel[i]->refreshName();
644 SelectionCollection::requiresTopology() const
649 if (!impl_->rpost_.empty())
652 // Should not throw, because has been checked earlier.
653 PositionCalculationCollection::typeFromEnum(impl_->rpost_.c_str(),
655 if (type != POS_ATOM)
660 if (!impl_->spost_.empty())
663 // Should not throw, because has been checked earlier.
664 PositionCalculationCollection::typeFromEnum(impl_->spost_.c_str(),
666 if (type != POS_ATOM)
672 SelectionTreeElementPointer sel = impl_->sc_.root;
675 if (_gmx_selelem_requires_top(*sel))
686 SelectionCollection::parseFromStdin(int nr, bool bInteractive,
687 const std::string &context)
691 _gmx_sel_init_lexer(&scanner, &impl_->sc_, bInteractive, nr,
692 impl_->bExternalGroupsSet_,
694 return runParser(scanner, true, nr, context);
699 SelectionCollection::parseFromFile(const std::string &filename)
705 File file(filename, "r");
706 // TODO: Exception-safe way of using the lexer.
707 _gmx_sel_init_lexer(&scanner, &impl_->sc_, false, -1,
708 impl_->bExternalGroupsSet_,
710 _gmx_sel_set_lex_input_file(scanner, file.handle());
711 return runParser(scanner, false, -1, std::string());
713 catch (GromacsException &ex)
715 ex.prependContext(formatString(
716 "Error in parsing selections from file '%s'",
724 SelectionCollection::parseFromString(const std::string &str)
728 _gmx_sel_init_lexer(&scanner, &impl_->sc_, false, -1,
729 impl_->bExternalGroupsSet_,
731 _gmx_sel_set_lex_input_str(scanner, str.c_str());
732 return runParser(scanner, false, -1, std::string());
737 SelectionCollection::compile()
739 if (impl_->sc_.top == NULL && requiresTopology())
741 GMX_THROW(InconsistentInputError("Selection requires topology information, but none provided"));
743 if (!impl_->bExternalGroupsSet_)
745 setIndexGroups(NULL);
747 if (impl_->debugLevel_ >= 1)
749 printTree(stderr, false);
752 SelectionCompiler compiler;
753 compiler.compile(this);
755 if (impl_->debugLevel_ >= 1)
757 std::fprintf(stderr, "\n");
758 printTree(stderr, false);
759 std::fprintf(stderr, "\n");
760 impl_->sc_.pcc.printTree(stderr);
761 std::fprintf(stderr, "\n");
763 impl_->sc_.pcc.initEvaluation();
764 if (impl_->debugLevel_ >= 1)
766 impl_->sc_.pcc.printTree(stderr);
767 std::fprintf(stderr, "\n");
770 // TODO: It would be nicer to associate the name of the selection option
771 // (if available) to the error message.
772 SelectionDataList::const_iterator iter;
773 for (iter = impl_->sc_.sel.begin(); iter != impl_->sc_.sel.end(); ++iter)
775 const internal::SelectionData &sel = **iter;
776 if (sel.hasFlag(efSelection_OnlyAtoms))
778 if (!sel.hasOnlyAtoms())
780 std::string message = formatString(
781 "Selection '%s' does not evaluate to individual atoms. "
782 "This is not allowed in this context.",
783 sel.selectionText());
784 GMX_THROW(InvalidInputError(message));
787 if (sel.hasFlag(efSelection_DisallowEmpty))
789 if (sel.posCount() == 0)
791 std::string message = formatString(
792 "Selection '%s' never matches any atoms.",
793 sel.selectionText());
794 GMX_THROW(InvalidInputError(message));
802 SelectionCollection::evaluate(t_trxframe *fr, t_pbc *pbc)
804 if (fr->natoms <= impl_->maxAtomIndex_)
806 std::string message = formatString(
807 "Trajectory has less atoms (%d) than what is required for "
808 "evaluating the provided selections (atoms up to index %d "
809 "are required).", fr->natoms, impl_->maxAtomIndex_ + 1);
810 GMX_THROW(InconsistentInputError(message));
812 impl_->sc_.pcc.initFrame();
814 SelectionEvaluator evaluator;
815 evaluator.evaluate(this, fr, pbc);
817 if (impl_->debugLevel_ >= 3)
819 std::fprintf(stderr, "\n");
820 printTree(stderr, true);
826 SelectionCollection::evaluateFinal(int nframes)
828 SelectionEvaluator evaluator;
829 evaluator.evaluateFinal(this, nframes);
834 SelectionCollection::printTree(FILE *fp, bool bValues) const
836 SelectionTreeElementPointer sel = impl_->sc_.root;
839 _gmx_selelem_print_tree(fp, *sel, bValues, 0);
846 SelectionCollection::printXvgrInfo(FILE *out, output_env_t oenv) const
848 if (output_env_get_xvg_format(oenv) != exvgNONE)
850 const gmx_ana_selcollection_t &sc = impl_->sc_;
851 std::fprintf(out, "# Selections:\n");
852 for (int i = 0; i < sc.nvars; ++i)
854 std::fprintf(out, "# %s\n", sc.varstrs[i]);
856 for (size_t i = 0; i < sc.sel.size(); ++i)
858 std::fprintf(out, "# %s\n", sc.sel[i]->selectionText());
860 std::fprintf(out, "#\n");