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 Helper functions for the selection tokenizer.
34 * This file implements the functions in the headers scanner.h and
37 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
38 * \ingroup module_selection
41 * \internal \file scanner_flex.h
42 * \brief Generated (from scanner.l) header file by Flex.
44 * This file contains definitions of functions that are needed in
45 * scanner_internal.cpp.
47 * \ingroup module_selection
55 #include "gromacs/legacyheaders/typedefs.h"
56 #include "gromacs/legacyheaders/smalloc.h"
57 #include "gromacs/legacyheaders/string2.h"
59 #include "gromacs/utility/exceptions.h"
60 #include "gromacs/utility/gmxassert.h"
61 #include "gromacs/utility/messagestringcollector.h"
62 #include "gromacs/utility/stringutil.h"
64 #include "parsetree.h"
65 #include "selectioncollection-impl.h"
67 #include "selmethod.h"
72 #include "scanner_internal.h"
74 //! Step in which the allocated memory for pretty-printed input is incremented.
75 #define STRSTORE_ALLOCSTEP 1000
77 /* These are defined as macros in the generated scanner_flex.h.
78 * We undefine them here to have them as variable names in the subroutines.
79 * There are other ways of doing this, but this is probably the easiest. */
85 * Handles initialization of method parameter token.
88 init_param_token(YYSTYPE *yylval, gmx_ana_selparam_t *param, bool bBoolNo)
92 GMX_RELEASE_ASSERT(param->name != NULL,
93 "bBoolNo should only be set for a parameters with a name");
94 snew(yylval->str, strlen(param->name) + 3);
97 strcpy(yylval->str+2, param->name);
101 yylval->str = param->name ? strdup(param->name) : NULL;
107 * Processes a selection method token.
110 init_method_token(YYSTYPE *yylval, gmx_ana_selmethod_t *method, bool bPosMod,
111 gmx_sel_lexer_t *state)
113 /* If the previous token was not KEYWORD_POS, return EMPTY_POSMOD
114 * before the actual method to work around a limitation in Bison. */
115 if (!bPosMod && method->type != POS_VALUE)
117 state->nextmethod = method;
120 yylval->meth = method;
121 if (!(method->flags & SMETH_MODIFIER) && method->nparams == 0)
124 switch (method->type)
126 case INT_VALUE: return KEYWORD_NUMERIC;
127 case REAL_VALUE: return KEYWORD_NUMERIC;
128 case STR_VALUE: return KEYWORD_STR;
129 case GROUP_VALUE: return KEYWORD_GROUP;
131 GMX_THROW(gmx::InternalError("Unsupported keyword type"));
136 /* Method with parameters or a modifier */
137 if (method->flags & SMETH_MODIFIER)
139 /* Remove all methods from the stack */
141 if (method->param[1].name == NULL)
143 state->nextparam = &method->param[1];
148 if (method->param[0].name == NULL)
150 state->nextparam = &method->param[0];
154 if (state->msp >= state->mstack_alloc)
156 state->mstack_alloc += 10;
157 srenew(state->mstack, state->mstack_alloc);
159 state->mstack[state->msp] = method;
160 if (method->flags & SMETH_MODIFIER)
164 switch (method->type)
166 case INT_VALUE: return METHOD_NUMERIC;
167 case REAL_VALUE: return METHOD_NUMERIC;
168 case POS_VALUE: return METHOD_POS;
169 case GROUP_VALUE: return METHOD_GROUP;
172 GMX_THROW(gmx::InternalError("Unsupported method type"));
175 return INVALID; /* Should not be reached */
179 _gmx_sel_lexer_process_pending(YYSTYPE *yylval, gmx_sel_lexer_t *state)
181 if (state->nextparam)
183 gmx_ana_selparam_t *param = state->nextparam;
184 bool bBoolNo = state->bBoolNo;
189 return END_OF_METHOD;
191 state->nextparam = NULL;
192 state->bBoolNo = false;
193 _gmx_sel_lexer_add_token(param->name, -1, state);
194 return init_param_token(yylval, param, bBoolNo);
196 if (state->prev_pos_kw > 0)
198 --state->prev_pos_kw;
200 if (state->nextmethod)
202 gmx_ana_selmethod_t *method = state->nextmethod;
204 state->nextmethod = NULL;
205 return init_method_token(yylval, method, true, state);
211 _gmx_sel_lexer_process_identifier(YYSTYPE *yylval, char *yytext, size_t yyleng,
212 gmx_sel_lexer_t *state)
214 /* Check if the identifier matches with a parameter name */
217 gmx_ana_selparam_t *param = NULL;
218 bool bBoolNo = false;
220 while (!param && sp >= 0)
223 for (i = 0; i < state->mstack[sp]->nparams; ++i)
225 /* Skip NULL parameters and too long parameters */
226 if (state->mstack[sp]->param[i].name == NULL
227 || strlen(state->mstack[sp]->param[i].name) > yyleng)
231 if (!strncmp(state->mstack[sp]->param[i].name, yytext, yyleng))
233 param = &state->mstack[sp]->param[i];
236 /* Check separately for a 'no' prefix on boolean parameters */
237 if (state->mstack[sp]->param[i].val.type == NO_VALUE
238 && yyleng > 2 && yytext[0] == 'n' && yytext[1] == 'o'
239 && !strncmp(state->mstack[sp]->param[i].name, yytext+2, yyleng-2))
241 param = &state->mstack[sp]->param[i];
253 if (param->val.type == NO_VALUE && !bBoolNo)
255 state->bMatchBool = true;
259 state->neom = state->msp - sp - 1;
260 state->nextparam = param;
261 state->bBoolNo = bBoolNo;
262 return END_OF_METHOD;
264 _gmx_sel_lexer_add_token(param->name, -1, state);
265 return init_param_token(yylval, param, bBoolNo);
269 /* Check if the identifier matches with a symbol */
270 const gmx::SelectionParserSymbol *symbol
271 = state->sc->symtab->findSymbol(std::string(yytext, yyleng), false);
272 /* If there is no match, return the token as a string */
275 yylval->str = gmx_strndup(yytext, yyleng);
276 _gmx_sel_lexer_add_token(yytext, yyleng, state);
279 _gmx_sel_lexer_add_token(symbol->name().c_str(), -1, state);
280 gmx::SelectionParserSymbol::SymbolType symtype = symbol->type();
281 /* Reserved symbols should have been caught earlier */
282 if (symtype == gmx::SelectionParserSymbol::ReservedSymbol)
284 GMX_THROW(gmx::InternalError(gmx::formatString(
285 "Mismatch between tokenizer and reserved symbol table (for '%s')",
286 symbol->name().c_str())));
288 /* For variable symbols, return the type of the variable value */
289 if (symtype == gmx::SelectionParserSymbol::VariableSymbol)
291 gmx::SelectionTreeElementPointer var = symbol->variableValue();
292 /* Return simple tokens for constant variables */
293 if (var->type == SEL_CONST)
298 yylval->i = var->v.u.i[0];
301 yylval->r = var->v.u.r[0];
306 GMX_THROW(gmx::InternalError("Unsupported variable type"));
309 yylval->sel = new gmx::SelectionTreeElementPointer(var);
312 case INT_VALUE: return VARIABLE_NUMERIC;
313 case REAL_VALUE: return VARIABLE_NUMERIC;
314 case POS_VALUE: return VARIABLE_POS;
315 case GROUP_VALUE: return VARIABLE_GROUP;
318 GMX_THROW(gmx::InternalError("Unsupported variable type"));
322 return INVALID; /* Should not be reached. */
324 /* For method symbols, return the correct type */
325 if (symtype == gmx::SelectionParserSymbol::MethodSymbol)
327 gmx_ana_selmethod_t *method = symbol->methodValue();
328 return init_method_token(yylval, method, state->prev_pos_kw > 0, state);
330 /* For position symbols, we need to return KEYWORD_POS, but we also need
331 * some additional handling. */
332 if (symtype == gmx::SelectionParserSymbol::PositionSymbol)
334 state->bMatchOf = true;
335 yylval->str = strdup(symbol->name().c_str());
336 state->prev_pos_kw = 2;
339 /* Should not be reached */
344 _gmx_sel_lexer_add_token(const char *str, int len, gmx_sel_lexer_t *state)
346 /* Do nothing if the string is empty, or if it is a space and there is
347 * no other text yet, or if there already is a space. */
348 if (!str || len == 0 || strlen(str) == 0
349 || (str[0] == ' ' && str[1] == 0
350 && (state->pslen == 0 || state->pselstr[state->pslen - 1] == ' ')))
358 /* Allocate more memory if necessary */
359 if (state->nalloc_psel - state->pslen < len)
361 int incr = STRSTORE_ALLOCSTEP < len ? len : STRSTORE_ALLOCSTEP;
362 state->nalloc_psel += incr;
363 srenew(state->pselstr, state->nalloc_psel);
365 /* Append the token to the stored string */
366 strncpy(state->pselstr + state->pslen, str, len);
368 state->pselstr[state->pslen] = 0;
372 _gmx_sel_init_lexer(yyscan_t *scannerp, struct gmx_ana_selcollection_t *sc,
373 bool bInteractive, int maxnr, bool bGroups,
374 struct gmx_ana_indexgrps_t *grps)
376 int rc = _gmx_sel_yylex_init(scannerp);
379 // TODO: Throw a more representative exception.
380 GMX_THROW(gmx::InternalError("Lexer initialization failed"));
383 gmx_sel_lexer_t *state = new gmx_sel_lexer_t;
386 state->errors = NULL;
387 state->bGroups = bGroups;
389 state->nexpsel = (maxnr > 0 ? static_cast<int>(sc->sel.size()) + maxnr : -1);
391 state->bInteractive = bInteractive;
393 snew(state->pselstr, STRSTORE_ALLOCSTEP);
394 state->pselstr[0] = 0;
396 state->nalloc_psel = STRSTORE_ALLOCSTEP;
398 snew(state->mstack, 20);
399 state->mstack_alloc = 20;
402 state->nextparam = NULL;
403 state->nextmethod = NULL;
404 state->prev_pos_kw = 0;
405 state->bBoolNo = false;
406 state->bMatchOf = false;
407 state->bMatchBool = false;
408 state->bCmdStart = true;
409 state->bBuffer = false;
411 _gmx_sel_yyset_extra(state, *scannerp);
415 _gmx_sel_free_lexer(yyscan_t scanner)
417 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
419 sfree(state->pselstr);
420 sfree(state->mstack);
423 _gmx_sel_yy_delete_buffer(state->buffer, scanner);
426 _gmx_sel_yylex_destroy(scanner);
430 _gmx_sel_set_lexer_error_reporter(yyscan_t scanner,
431 gmx::MessageStringCollector *errors)
433 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
434 state->errors = errors;
438 _gmx_sel_lexer_set_exception(yyscan_t scanner,
439 const boost::exception_ptr &ex)
441 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
442 state->exception = ex;
446 _gmx_sel_lexer_rethrow_exception_if_occurred(yyscan_t scanner)
448 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
449 if (state->exception)
451 boost::exception_ptr ex = state->exception;
452 state->exception = boost::exception_ptr();
453 rethrow_exception(ex);
458 _gmx_sel_is_lexer_interactive(yyscan_t scanner)
460 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
461 return state->bInteractive;
464 struct gmx_ana_selcollection_t *
465 _gmx_sel_lexer_selcollection(yyscan_t scanner)
467 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
471 gmx::MessageStringCollector *
472 _gmx_sel_lexer_error_reporter(yyscan_t scanner)
474 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
475 GMX_RELEASE_ASSERT(state->errors != NULL, "Error reporter not set");
476 return state->errors;
480 _gmx_sel_lexer_has_groups_set(yyscan_t scanner)
482 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
483 return state->bGroups;
486 struct gmx_ana_indexgrps_t *
487 _gmx_sel_lexer_indexgrps(yyscan_t scanner)
489 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
494 _gmx_sel_lexer_exp_selcount(yyscan_t scanner)
496 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
497 return state->nexpsel;
501 _gmx_sel_lexer_pselstr(yyscan_t scanner)
503 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
504 return state->pselstr;
508 _gmx_sel_lexer_clear_pselstr(yyscan_t scanner)
510 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
511 state->pselstr[0] = 0;
516 _gmx_sel_lexer_clear_method_stack(yyscan_t scanner)
518 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
524 _gmx_sel_finish_method(yyscan_t scanner)
526 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
535 _gmx_sel_set_lex_input_file(yyscan_t scanner, FILE *fp)
537 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
539 state->bBuffer = true;
540 state->buffer = _gmx_sel_yy_create_buffer(fp, YY_BUF_SIZE, scanner);
541 _gmx_sel_yy_switch_to_buffer(state->buffer, scanner);
545 _gmx_sel_set_lex_input_str(yyscan_t scanner, const char *str)
547 gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
551 _gmx_sel_yy_delete_buffer(state->buffer, scanner);
553 state->bBuffer = true;
554 state->buffer = _gmx_sel_yy_scan_string(str, scanner);