2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2009,2010,2011,2012,2014,2015, 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 * Parser/scanner interaction functions.
39 * This is an implementation header: there should be no need to use it outside
42 * \author Teemu Murtola <teemu.murtola@gmail.com>
43 * \ingroup module_selection
45 #ifndef SELECTION_SCANNER_H
46 #define SELECTION_SCANNER_H
50 #include <boost/exception_ptr.hpp>
59 struct gmx_ana_indexgrps_t;
60 struct gmx_ana_selcollection_t;
62 #ifndef YY_TYPEDEF_YY_SCANNER_T
63 #define YY_TYPEDEF_YY_SCANNER_T
64 typedef void *yyscan_t;
67 /** Initializes the selection scanner. */
69 _gmx_sel_init_lexer(yyscan_t *scannerp, struct gmx_ana_selcollection_t *sc,
70 gmx::TextWriter *statusWriter, int maxnr, bool bGroups,
71 struct gmx_ana_indexgrps_t *grps);
72 /** Frees memory allocated for the selection scanner. */
74 _gmx_sel_free_lexer(yyscan_t scanner);
75 /** Stores an exception that is caught during parsing. */
77 _gmx_sel_lexer_set_exception(yyscan_t scanner,
78 const boost::exception_ptr &ex);
79 /** Rethrows and clears the stored exception if one is present. */
80 // TODO: The semantics is a bit confusing, need to be thought more,
81 // but easier to do as part of larger refactoring of the parsing.
83 _gmx_sel_lexer_rethrow_exception_if_occurred(yyscan_t scanner);
85 /** Returns writer for status output (if not NULL, the scanner is interactive). */
87 _gmx_sel_lexer_get_status_writer(yyscan_t scanner);
88 /** Returns the selection collection for the scanner. */
89 struct gmx_ana_selcollection_t *
90 _gmx_sel_lexer_selcollection(yyscan_t scanner);
91 /** Returns true if the external index groups for the scanner are set. */
93 _gmx_sel_lexer_has_groups_set(yyscan_t scanner);
94 /** Returns the external index groups for the scanner. */
95 struct gmx_ana_indexgrps_t *
96 _gmx_sel_lexer_indexgrps(yyscan_t scanner);
97 /** Returns the number of selections after which the parser should stop. */
99 _gmx_sel_lexer_exp_selcount(yyscan_t scanner);
101 /** Returns a pretty string of the current selection. */
103 _gmx_sel_lexer_pselstr(yyscan_t scanner);
105 * Sets the current parser context location.
107 * This location is set while Bison reductions are being processed, and
108 * identifies the location of the current rule/reduction.
111 _gmx_sel_lexer_set_current_location(yyscan_t scanner,
112 const gmx::SelectionLocation &location);
114 * Returns the current parser context location.
116 * This returns the location last set with
117 * _gmx_sel_lexer_set_current_location().
119 const gmx::SelectionLocation &
120 _gmx_sel_lexer_get_current_location(yyscan_t scanner);
122 * Returns the selection text for the current parser context.
124 * This returns the selection text that corresponds to the position set last
125 * with _gmx_sel_lexer_set_current_location().
128 _gmx_sel_lexer_get_current_text(yyscan_t scanner);
130 * Returns the selection text at the given location.
133 _gmx_sel_lexer_get_text(yyscan_t scanner,
134 const gmx::SelectionLocation &location);
135 /** Clears the current selection string. */
137 _gmx_sel_lexer_clear_pselstr(yyscan_t scanner);
138 /** Clears the method stack in the scanner in error situations. */
140 _gmx_sel_lexer_clear_method_stack(yyscan_t scanner);
141 /** Notifies the scanner that a complete method expression has been parsed. */
143 _gmx_sel_finish_method(yyscan_t scanner);
144 /** Initializes the scanner to scan a file. */
146 _gmx_sel_set_lex_input_file(yyscan_t scanner, FILE *fp);
147 /** Initializes the scanner to scan a string. */
149 _gmx_sel_set_lex_input_str(yyscan_t scanner, const char *str);
151 /** The scanning function generated by Flex. */
152 #define YY_DECL int _gmx_sel_yylex(YYSTYPE *yylval, YYLTYPE *yylloc, yyscan_t yyscanner)