/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2009,2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \internal \file
* \brief
* This header also defines ::gmx_ana_selcollection_t, which is used in the old
* C code for handling selection collections.
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \ingroup module_selection
*/
#ifndef GMX_SELECTION_SELECTIONCOLLECTION_IMPL_H
#include <string>
#include <vector>
-#include "../legacyheaders/typedefs.h"
+#include <boost/scoped_ptr.hpp>
+
+#include "gromacs/onlinehelp/helptopicinterface.h"
+#include "gromacs/selection/indexutil.h"
+#include "gromacs/selection/selection.h" // For gmx::SelectionList
+#include "gromacs/selection/selectioncollection.h"
+#include "gromacs/utility/uniqueptr.h"
-#include "../onlinehelp/helptopicinterface.h"
-#include "../options/options.h"
-#include "../utility/uniqueptr.h"
-#include "indexutil.h"
#include "poscalc.h"
-#include "selection.h" // For gmx::SelectionList
-#include "selectioncollection.h"
+#include "selelem.h"
+
+struct gmx_sel_mempool_t;
+struct t_pbc;
+struct t_topology;
+struct t_trxframe;
namespace gmx
{
+
//! Smart pointer for managing an internal selection data object.
typedef gmx_unique_ptr<internal::SelectionData>::type SelectionDataPointer;
//! Container for storing a list of selections internally.
typedef std::vector<SelectionDataPointer> SelectionDataList;
-}
+
+class SelectionParserSymbolTable;
+
+} // namespace gmx
/*! \internal \brief
* Information for a collection of selections.
*/
struct gmx_ana_selcollection_t
{
- /** Root of the selection element tree. */
- struct t_selelem *root;
+ //! Position calculation collection used for selection position evaluation.
+ gmx::PositionCalculationCollection pcc;
+ //! Root of the selection element tree.
+ gmx::SelectionTreeElementPointer root;
/*! \brief
* Array of compiled selections.
*
char **varstrs;
/** Topology for the collection. */
- t_topology *top;
+ t_topology *top;
/** Index group that contains all the atoms. */
- struct gmx_ana_index_t gall;
- /** Position calculation collection used for selection position evaluation. */
- gmx::PositionCalculationCollection pcc;
+ gmx_ana_index_t gall;
/** Memory pool used for selection evaluation. */
- struct gmx_sel_mempool_t *mempool;
- /** Parser symbol table. */
- struct gmx_sel_symtab_t *symtab;
+ gmx_sel_mempool_t *mempool;
+ //! Parser symbol table.
+ boost::scoped_ptr<gmx::SelectionParserSymbolTable> symtab;
//! Root of help topic tree (NULL is no help yet requested).
- gmx::HelpTopicPointer rootHelp;
+ gmx::HelpTopicPointer rootHelp;
};
namespace gmx
{
-class MessageStringCollector;
+class ExceptionInitializer;
/*! \internal \brief
* Private implemention class for SelectionCollection.
*
* \param[in] root Root of selection tree to process.
* \param errors Object for reporting any error messages.
+ * \throws std::bad_alloc if out of memory.
*
* Recursively searches the selection tree for unresolved external
* references. If one is found, finds the referenced group in
- * \a _grps and replaces the reference with a constant element that
+ * \a grps_ and replaces the reference with a constant element that
* contains the atoms from the referenced group. Any failures to
* resolve references are reported to \p errors.
- *
- * Does not throw currently, but this is subject to change when more
- * underlying code is converted to C++.
*/
- void resolveExternalGroups(struct t_selelem *root,
- MessageStringCollector *errors);
+ void resolveExternalGroups(const gmx::SelectionTreeElementPointer &root,
+ ExceptionInitializer *errors);
//! Internal data, used for interfacing with old C code.
- gmx_ana_selcollection_t _sc;
- //! Options object for setting global properties on the collection.
- Options _options;
+ gmx_ana_selcollection_t sc_;
//! Default reference position type for selections.
- std::string _rpost;
+ std::string rpost_;
//! Default output position type for selections.
- std::string _spost;
+ std::string spost_;
+ //! Largest atom index needed by the selections for evaluation.
+ int maxAtomIndex_;
/*! \brief
* Debugging level for the collection.
*
* - 3: like 1, also print the tree after evaluation
* - 4: combine 2 and 3
*/
- int _debugLevel;
+ int debugLevel_;
//! Whether setIndexGroups() has been called.
- bool _bExternalGroupsSet;
+ bool bExternalGroupsSet_;
//! External index groups (can be NULL).
- gmx_ana_indexgrps_t *_grps;
+ gmx_ana_indexgrps_t *grps_;
};
-/*! \internal \brief
+/*! \internal
+ * \brief
* Implements selection evaluation.
*
* This class is used to implement SelectionCollection::evaluate() and