2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,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.
36 * \brief Helper functions for the selection parser.
38 * This header is includes only from parser.cpp (generated from parser.y), and
39 * it includes functions and macros used internally by the parser.
40 * They are in a separate file to make then easier to edit (no need to
41 * regenerate the parser), and to keep parser.y as simple as possible.
43 * \author Teemu Murtola <teemu.murtola@gmail.com>
44 * \ingroup module_selection
46 #ifndef GMX_SELECTION_PARSER_INTERNAL_H
47 #define GMX_SELECTION_PARSER_INTERNAL_H
53 #include <boost/scoped_ptr.hpp>
55 #include "gromacs/utility/gmxassert.h"
57 #include "parsetree.h"
61 //! Error handler needed by Bison.
63 yyerror(yyscan_t scanner, char const *s)
65 _gmx_selparser_error(scanner, "%s", s);
68 /*! \name Exception handling macros for actions
70 * These macros should be used at the beginning and end of each semantic action
71 * that may throw an exception. For robustness, it's best to wrap all actions
72 * that call functions declared outside parser.y should be wrapped.
73 * These macros take care to catch any exceptions, store the exception (or
74 * handle it and allow the parser to continue), and terminate the parser
75 * cleanly if necessary.
76 * The code calling the parser should use
77 * _gmx_sel_lexer_rethrow_exception_if_occurred() to rethrow any exceptions.
80 //! Starts an action that may throw exceptions.
81 #define BEGIN_ACTION \
83 //! Finishes an action that may throw exceptions.
86 catch (const std::exception &ex) \
88 if (_gmx_selparser_handle_exception(scanner, ex)) { \
96 //! No-op to enable use of same get()/set() implementation as with C++11.
97 static gmx::SelectionParserValue &move(gmx::SelectionParserValue &src)
101 //! No-op to enable use of same get()/set() implementation as with C++11.
102 static gmx::SelectionParserParameter &move(gmx::SelectionParserParameter &src)
109 * Retrieves a semantic value.
111 * \param[in] src Semantic value to get the value from.
112 * \returns Retrieved value.
113 * \throws unspecified Any exception thrown by the move constructor of
114 * ValueType (copy constructor if GMX_CXX11 is not set).
116 * There should be no statements that may throw exceptions in actions before
117 * this function has been called for all semantic values that have a C++ object
118 * stored. Together with set(), this function abstracts away exception
119 * safety issues that arise from the use of a plain pointer for storing the
122 * Does not throw for smart pointer types. If used with types that may throw,
123 * the order of operations should be such that it is exception-safe.
125 template <typename ValueType> static
126 ValueType get(ValueType *src)
128 GMX_RELEASE_ASSERT(src != NULL, "Semantic value pointers should be non-NULL");
129 boost::scoped_ptr<ValueType> srcGuard(src);
130 return ValueType(move(*src));
133 * Sets a semantic value.
135 * \tparam ValueType Type of value to set.
136 * \param[out] dest Semantic value to set (typically $$).
137 * \param[in] value Value to put into the semantic value.
138 * \throws std::bad_alloc if out of memory.
139 * \throws unspecified Any exception thrown by the move constructor of
140 * ValueType (copy constructor if GMX_CXX11 is not set).
142 * This should be the last statement before ::END_ACTION, except for a
143 * possible ::CHECK_SEL.
145 template <typename ValueType> static
146 void set(ValueType * &dest, ValueType value)
148 dest = new ValueType(move(value));
151 * Sets an empty semantic value.
153 * \tparam ValueType Type of value to set (must be default constructible).
154 * \param[out] dest Semantic value to set (typically $$).
155 * \throws std::bad_alloc if out of memory.
156 * \throws unspecified Any exception thrown by the default constructor of
159 * This should be the last statement before ::END_ACTION, except for a
160 * possible ::CHECK_SEL.
162 template <typename ValueType> static
163 void set_empty(ValueType * &dest)
165 dest = new ValueType;
168 * Checks that a valid tree was set.
170 * Should be called after set() if it was used to set a value where NULL
171 * pointer indicates an error.
174 * Get rid of this macro. It should now be possible to handle all errors using
177 #define CHECK_SEL(sel) \