3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
9 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
10 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
11 * Copyright (c) 2001-2009, The GROMACS development team,
12 * check out http://www.gromacs.org for more information.
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version 2
17 * of the License, or (at your option) any later version.
19 * If you want to redistribute modifications, please consider that
20 * scientific software is very special. Version control is crucial -
21 * bugs must be traceable. We will be happy to consider code for
22 * inclusion in the official distribution, but derived work must not
23 * be called official GROMACS. Details are found in the README & COPYING
24 * files - if they are missing, get the official version at www.gromacs.org.
26 * To help us fund GROMACS development, we humbly ask that you cite
27 * the papers on the package - you can find them in the top README file.
29 * For more info, check our website at http://www.gromacs.org
32 * \brief Internal header file used by the selection tokenizer.
34 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
35 * \ingroup module_selection
37 #ifndef SELECTION_SCANNER_INTERNAL_H
38 #define SELECTION_SCANNER_INTERNAL_H
42 class MessageStringCollector;
47 /* These need to be defined before including scanner_flex.h, because it
48 * uses YY_EXTRA_TYPE. But we also need to include it before defining
49 * gmx_sel_lexer_t; hence the forward declaration. */
50 struct gmx_sel_lexer_t;
51 #define YY_EXTRA_TYPE struct gmx_sel_lexer_t *
53 /* We cannot include scanner_flex.h from the scanner itself, because it
54 * seems to break everything. */
55 /* And we need to define YY_NO_UNISTD_H here as well, otherwise unistd.h
56 * gets included in other files than scanner.cpp... */
58 #define YY_NO_UNISTD_H
59 #include "scanner_flex.h"
63 * Internal data structure for the selection tokenizer state.
65 typedef struct gmx_sel_lexer_t
67 //! Selection collection to put parsed selections in.
68 struct gmx_ana_selcollection_t *sc;
69 //! Error reporter object.
70 gmx::MessageStringCollector *errors;
71 //! Whether external index groups have been set.
73 //! External index groups for resolving \c group keywords.
74 struct gmx_ana_indexgrps_t *grps;
75 //! Number of selections at which the parser should stop.
78 //! Whether the parser is interactive.
81 //! Pretty-printed version of the string parsed since last clear.
83 //! Length of the string in \a pselstr.
85 //! Number of bytes allocated for \a pselstr.
88 //! Stack of methods in which parameters should be looked up.
89 struct gmx_ana_selmethod_t **mstack;
90 //! Index of the top of the stack in \a mstack.
92 //! Number of elements allocated for \a mstack.
95 //! Number of END_OF_METHOD tokens to return before \a nextparam.
97 //! Parameter symbol to return before resuming scanning.
98 struct gmx_ana_selparam_t *nextparam;
99 //! Whether \a nextparam was a boolean parameter with a 'no' prefix.
102 * Method symbol to return before resuming scanning
104 * Only used when \p nextparam is NULL.
106 struct gmx_ana_selmethod_t *nextmethod;
107 //! Used to track whether the previous token was a position modifier.
110 //! Whether the 'of' keyword is acceptable as the next token.
112 //! Whether boolean values (yes/no/on/off) are acceptable as the next token.
114 //! Whether the next token starts a new selection.
117 //! Whether an external buffer is set for the scanner.
119 //! The current buffer for the scanner.
120 YY_BUFFER_STATE buffer;
123 /* Because Flex defines yylval, yytext, and yyleng as macros,
124 * and this file is included from scanner.l,
125 * we cannot have them here as parameter names... */
126 /** Internal function for cases where several tokens need to be returned. */
128 _gmx_sel_lexer_process_pending(YYSTYPE *, gmx_sel_lexer_t *state);
129 /** Internal function that processes identifier tokens. */
131 _gmx_sel_lexer_process_identifier(YYSTYPE *, char *, size_t,
132 gmx_sel_lexer_t *state);
133 /** Internal function to add a token to the pretty-printed selection text. */
135 _gmx_sel_lexer_add_token(const char *str, int len, gmx_sel_lexer_t *state);