2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2009,2010,2011,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 tokenizer.
38 * This file implements the functions in the headers scanner.h and
41 * \author Teemu Murtola <teemu.murtola@gmail.com>
42 * \ingroup module_selection
45 * \internal \file scanner_flex.h
46 * \brief Generated (from scanner.l) header file by Flex.
48 * This file contains definitions of functions that are needed in
49 * scanner_internal.cpp.
51 * \ingroup module_selection
56 #include "scanner_internal.h"
63 #include "gromacs/utility/cstringutil.h"
64 #include "gromacs/utility/exceptions.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"
71 #include "parsetree.h"
73 #include "selectioncollection-impl.h"
75 #include "selmethod.h"
79 * Step in which the allocated memory for pretty-printed input is incremented.
81 #define STRSTORE_ALLOCSTEP 1000
83 /* These are defined as macros in the generated scanner_flex.h.
84 * We undefine them here to have them as variable names in the subroutines.
85 * There are other ways of doing this, but this is probably the easiest. */
91 * Handles initialization of method parameter token.
94 init_param_token(YYSTYPE *yylval, gmx_ana_selparam_t *param, bool bBoolNo)
98 GMX_RELEASE_ASSERT(param->name != NULL,
99 "bBoolNo should only be set for a parameters with a name");
100 snew(yylval->str, strlen(param->name) + 3);
101 yylval->str[0] = 'n';
102 yylval->str[1] = 'o';
103 strcpy(yylval->str+2, param->name);
107 yylval->str = param->name ? gmx_strdup(param->name) : NULL;
113 * Processes a selection method token.
116 init_method_token(YYSTYPE *yylval, gmx_ana_selmethod_t *method, bool bPosMod,
117 gmx_sel_lexer_t *state)
119 /* If the previous token was not KEYWORD_POS, return EMPTY_POSMOD
120 * before the actual method to work around a limitation in Bison. */
121 if (!bPosMod && method->type != POS_VALUE)
123 state->nextmethod = method;
126 yylval->meth = method;
127 if (!(method->flags & SMETH_MODIFIER) && method->nparams == 0)
130 switch (method->type)
132 case INT_VALUE: return KEYWORD_NUMERIC;
133 case REAL_VALUE: return KEYWORD_NUMERIC;
134 case STR_VALUE: return KEYWORD_STR;
135 case GROUP_VALUE: return KEYWORD_GROUP;
137 GMX_THROW(gmx::InternalError("Unsupported keyword type"));
142 /* Method with parameters or a modifier */
143 if (method->flags & SMETH_MODIFIER)
145 /* Remove all methods from the stack */
147 if (method->param[1].name == NULL)
149 state->nextparam = &method->param[1];
154 if (method->param[0].name == NULL)
156 state->nextparam = &method->param[0];
160 if (state->msp >= state->mstack_alloc)
162 state->mstack_alloc += 10;
163 srenew(state->mstack, state->mstack_alloc);
165 state->mstack[state->msp] = method;
166 if (method->flags & SMETH_MODIFIER)
170 switch (method->type)
172 case INT_VALUE: return METHOD_NUMERIC;
173 case REAL_VALUE: return METHOD_NUMERIC;
174 case POS_VALUE: return METHOD_POS;
175 case GROUP_VALUE: return METHOD_GROUP;
178 GMX_THROW(gmx::InternalError("Unsupported method type"));
181 return INVALID; /* Should not be reached */
185 _gmx_sel_lexer_process_pending(YYSTYPE *yylval, gmx_sel_lexer_t *state)
187 if (state->nextparam)
189 gmx_ana_selparam_t *param = state->nextparam;
190 bool bBoolNo = state->bBoolNo;
195 return END_OF_METHOD;
197 state->nextparam = NULL;
198 state->bBoolNo = false;
199 _gmx_sel_lexer_add_token(param->name, -1, state);
200 return init_param_token(yylval, param, bBoolNo);
202 if (state->prev_pos_kw > 0)
204 --state->prev_pos_kw;
206 if (state->nextmethod)
208 gmx_ana_selmethod_t *method = state->nextmethod;
210 state->nextmethod = NULL;
211 return init_method_token(yylval, method, true, state);
217 _gmx_sel_lexer_process_identifier(YYSTYPE *yylval, char *yytext, size_t yyleng,
218 gmx_sel_lexer_t *state)
220 /* Check if the identifier matches with a parameter name */
223 gmx_ana_selparam_t *param = NULL;
224 bool bBoolNo = false;
226 while (!param && sp >= 0)
229 for (i = 0; i < state->mstack[sp]->nparams; ++i)
231 /* Skip NULL parameters and too long parameters */
232 if (state->mstack[sp]->param[i].name == NULL
233 || strlen(state->mstack[sp]->param[i].name) > yyleng)
237 if (!strncmp(state->mstack[sp]->param[i].name, yytext, yyleng))
239 param = &state->mstack[sp]->param[i];
242 /* Check separately for a 'no' prefix on boolean parameters */
243 if (state->mstack[sp]->param[i].val.type == NO_VALUE
244 && yyleng > 2 && yytext[0] == 'n' && yytext[1] == 'o'
245 && !strncmp(state->mstack[sp]->param[i].name, yytext+2, yyleng-2))
247 param = &state->mstack[sp]->param[i];
259 if (param->val.type == NO_VALUE && !bBoolNo)
261 state->bMatchBool = true;
265 state->neom = state->msp - sp - 1;
266 state->nextparam = param;
267 state->bBoolNo = bBoolNo;
268 return END_OF_METHOD;
270 _gmx_sel_lexer_add_token(param->name, -1, state);
271 return init_param_token(yylval, param, bBoolNo);
275 /* Check if the identifier matches with a symbol */
276 const gmx::SelectionParserSymbol *symbol
277 = state->sc->symtab->findSymbol(std::string(yytext, yyleng), false);
278 /* If there is no match, return the token as a string */
281 yylval->str = gmx_strndup(yytext, yyleng);
282 _gmx_sel_lexer_add_token(yytext, yyleng, state);
285 _gmx_sel_lexer_add_token(symbol->name().c_str(), -1, state);
286 gmx::SelectionParserSymbol::SymbolType symtype = symbol->type();
287 /* Reserved symbols should have been caught earlier */
288 if (symtype == gmx::SelectionParserSymbol::ReservedSymbol)
290 GMX_THROW(gmx::InternalError(gmx::formatString(
291 "Mismatch between tokenizer and reserved symbol table (for '%s')",
292 symbol->name().c_str())));
294 /* For variable symbols, return the type of the variable value */
295 if (symtype == gmx::SelectionParserSymbol::VariableSymbol)
297 gmx::SelectionTreeElementPointer var = symbol->variableValue();
298 /* Return simple tokens for constant variables */
299 if (var->type == SEL_CONST)
304 yylval->i = var->v.u.i[0];
307 yylval->r = var->v.u.r[0];
312 GMX_THROW(gmx::InternalError("Unsupported variable type"));
315 yylval->sel = new gmx::SelectionTreeElementPointer(var);
318 case INT_VALUE: return VARIABLE_NUMERIC;
319 case REAL_VALUE: return VARIABLE_NUMERIC;
320 case POS_VALUE: return VARIABLE_POS;
321 case GROUP_VALUE: return VARIABLE_GROUP;
324 GMX_THROW(gmx::InternalError("Unsupported variable type"));
327 /* This position should not be reached. */
329 /* For method symbols, return the correct type */
330 if (symtype == gmx::SelectionParserSymbol::MethodSymbol)
332 gmx_ana_selmethod_t *method = symbol->methodValue();
333 return init_method_token(yylval, method, state->prev_pos_kw > 0, state);
335 /* For position symbols, we need to return KEYWORD_POS, but we also need
336 * some additional handling. */
337 if (symtype == gmx::SelectionParserSymbol::PositionSymbol)
339 state->bMatchOf = true;
340 yylval->str = gmx_strdup(symbol->name().c_str());
341 state->prev_pos_kw = 2;
344 /* Should not be reached */
349 _gmx_sel_lexer_add_token(const char *str, int len, gmx_sel_lexer_t *state)
351 /* Do nothing if the string is empty, or if it is a space and there is
352 * no other text yet, or if there already is a space. */
353 if (!str || len == 0 || strlen(str) == 0
354 || (str[0] == ' ' && str[1] == 0
355 && (state->pslen == 0 || state->pselstr[state->pslen - 1] == ' ')))
363 /* Allocate more memory if necessary */
364 if (state->nalloc_psel - state->pslen < len)
366 int incr = STRSTORE_ALLOCSTEP < len ? len : STRSTORE_ALLOCSTEP;
367 state->nalloc_psel += incr;
368 srenew(state->pselstr, state->nalloc_psel);
370 /* Append the token to the stored string */
371 strncpy(state->pselstr + state->pslen, str, len);
373 state->pselstr[state->pslen] = 0;
377 _gmx_sel_init_lexer(yyscan_t *scannerp, struct gmx_ana_selcollection_t *sc,
378 bool bInteractive, int maxnr, bool bGroups,
379 struct gmx_ana_indexgrps_t *grps)
381 int rc = _gmx_sel_yylex_init(scannerp);
384 // TODO: Throw a more representative exception.
385 GMX_THROW(gmx::InternalError("Lexer initialization failed"));
388 gmx_sel_lexer_t *state = new gmx_sel_lexer_t;
391 state->errors = NULL;
392 state->bGroups = bGroups;
394 state->nexpsel = (maxnr > 0 ? static_cast<int>(sc->sel.size()) + maxnr : -1);
396 state->bInteractive = bInteractive;
398 snew(state->pselstr, STRSTORE_ALLOCSTEP);
399 state->pselstr[0] = 0;
401 state->nalloc_psel = STRSTORE_ALLOCSTEP;
403 snew(state->mstack, 20);
404 state->mstack_alloc = 20;
407 state->nextparam = NULL;
408 state->nextmethod = NULL;
409 state->prev_pos_kw = 0;
410 state->bBoolNo = false;
411 state->bMatchOf = false;
412 state->bMatchBool = false;
413 state->bCmdStart = true;
414 state->bBuffer = false;
416 _gmx_sel_yyset_extra(state, *scannerp);
420 _gmx_sel_free_lexer(yyscan_t scanner)
422 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
424 sfree(state->pselstr);
425 sfree(state->mstack);
428 _gmx_sel_yy_delete_buffer(state->buffer, scanner);
431 _gmx_sel_yylex_destroy(scanner);
435 _gmx_sel_set_lexer_error_reporter(yyscan_t scanner,
436 gmx::MessageStringCollector *errors)
438 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
439 state->errors = errors;
443 _gmx_sel_lexer_set_exception(yyscan_t scanner,
444 const boost::exception_ptr &ex)
446 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
447 state->exception = ex;
451 _gmx_sel_lexer_rethrow_exception_if_occurred(yyscan_t scanner)
453 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
454 if (state->exception)
456 boost::exception_ptr ex = state->exception;
457 state->exception = boost::exception_ptr();
458 rethrow_exception(ex);
463 _gmx_sel_is_lexer_interactive(yyscan_t scanner)
465 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
466 return state->bInteractive;
469 struct gmx_ana_selcollection_t *
470 _gmx_sel_lexer_selcollection(yyscan_t scanner)
472 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
476 gmx::MessageStringCollector *
477 _gmx_sel_lexer_error_reporter(yyscan_t scanner)
479 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
480 GMX_RELEASE_ASSERT(state->errors != NULL, "Error reporter not set");
481 return state->errors;
485 _gmx_sel_lexer_has_groups_set(yyscan_t scanner)
487 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
488 return state->bGroups;
491 struct gmx_ana_indexgrps_t *
492 _gmx_sel_lexer_indexgrps(yyscan_t scanner)
494 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
499 _gmx_sel_lexer_exp_selcount(yyscan_t scanner)
501 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
502 return state->nexpsel;
506 _gmx_sel_lexer_pselstr(yyscan_t scanner)
508 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
509 return state->pselstr;
513 _gmx_sel_lexer_clear_pselstr(yyscan_t scanner)
515 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
516 state->pselstr[0] = 0;
521 _gmx_sel_lexer_clear_method_stack(yyscan_t scanner)
523 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
529 _gmx_sel_finish_method(yyscan_t scanner)
531 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
540 _gmx_sel_set_lex_input_file(yyscan_t scanner, FILE *fp)
542 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
544 state->bBuffer = true;
545 state->buffer = _gmx_sel_yy_create_buffer(fp, YY_BUF_SIZE, scanner);
546 _gmx_sel_yy_switch_to_buffer(state->buffer, scanner);
550 _gmx_sel_set_lex_input_str(yyscan_t scanner, const char *str)
552 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
556 _gmx_sel_yy_delete_buffer(state->buffer, scanner);
558 state->bBuffer = true;
559 state->buffer = _gmx_sel_yy_scan_string(str, scanner);