src/gromacs/selection/scanner_internal.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2012,2014,2015,2016,2017,2018, 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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \internal \file
  36  * \brief Helper functions for the selection tokenizer.
  37  *
  38  * This file implements the functions in the headers scanner.h and
  39  * scanner_internal.h.
  40  *
  41  * \author Teemu Murtola <teemu.murtola@gmail.com>
  42  * \ingroup module_selection
  43  */
  44 /*! \cond
  45  * \internal \file scanner_flex.h
  46  * \brief Generated (from scanner.l) header file by Flex.
  47  *
  48  * This file contains definitions of functions that are needed in
  49  * scanner_internal.cpp.
  50  *
  51  * \ingroup module_selection
  52  * \endcond
  53  */
  54 #include "gmxpre.h"
  55
  56 #include "scanner_internal.h"
  57
  58 #include <stdlib.h>
  59 #include <string.h>
  60
  61 #include <string>
  62
  63 #include "gromacs/utility/cstringutil.h"
  64 #include "gromacs/utility/exceptions.h"
  65 #include "gromacs/utility/gmxassert.h"
  66 #include "gromacs/utility/smalloc.h"
  67 #include "gromacs/utility/stringutil.h"
  68
  69 #include "parser.h"
  70 #include "parsetree.h"
  71 #include "scanner.h"
  72 #include "selectioncollection-impl.h"
  73 #include "selelem.h"
  74 #include "selmethod.h"
  75 #include "symrec.h"
  76
  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. */
  80 #undef yylval
  81 #undef yytext
  82 #undef yyleng
  83
  84 /*! \brief
  85  * Handles initialization of method parameter token.
  86  */
  87 static int
  88 init_param_token(YYSTYPE *yylval, gmx_ana_selparam_t *param, bool bBoolNo)
  89 {
  90     if (bBoolNo)
  91     {
  92         GMX_RELEASE_ASSERT(param->name != nullptr,
  93                            "bBoolNo should only be set for a parameters with a name");
  94         snew(yylval->str, strlen(param->name) + 3);
  95         yylval->str[0] = 'n';
  96         yylval->str[1] = 'o';
  97         strcpy(yylval->str+2, param->name);
  98     }
  99     else
 100     {
 101         yylval->str = param->name ? gmx_strdup(param->name) : nullptr;
 102     }
 103     return PARAM;
 104 }
 105
 106 /*! \brief
 107  * Processes a selection method token.
 108  */
 109 static int
 110 init_method_token(YYSTYPE *yylval, YYLTYPE *yylloc,
 111                   const gmx::SelectionParserSymbol *symbol,
 112                   bool bPosMod, gmx_sel_lexer_t *state)
 113 {
 114     gmx_ana_selmethod_t *method = symbol->methodValue();
 115     /* If the previous token was not KEYWORD_POS, return EMPTY_POSMOD
 116      * before the actual method to work around a limitation in Bison. */
 117     if (!bPosMod && method->type != POS_VALUE)
 118     {
 119         state->nextMethodSymbol = symbol;
 120         _gmx_sel_lexer_add_token(yylloc, nullptr, 0, state);
 121         return EMPTY_POSMOD;
 122     }
 123     _gmx_sel_lexer_add_token(yylloc, symbol->name().c_str(), -1, state);
 124     yylval->meth = method;
 125     if (!(method->flags & SMETH_MODIFIER) && method->nparams == 0)
 126     {
 127         /* Keyword */
 128         switch (method->type)
 129         {
 130             case INT_VALUE:
 131             case REAL_VALUE:
 132                 state->bMatchOf = true;
 133                 return KEYWORD_NUMERIC;
 134             case STR_VALUE:   return KEYWORD_STR;
 135             case GROUP_VALUE: return KEYWORD_GROUP;
 136             default:
 137                 GMX_THROW(gmx::InternalError("Unsupported keyword type"));
 138         }
 139     }
 140     else
 141     {
 142         /* Method with parameters or a modifier */
 143         if (method->flags & SMETH_MODIFIER)
 144         {
 145             /* Remove all methods from the stack */
 146             state->msp = -1;
 147             if (method->param[1].name == nullptr)
 148             {
 149                 state->nextparam = &method->param[1];
 150             }
 151         }
 152         else
 153         {
 154             if (method->param[0].name == nullptr)
 155             {
 156                 state->nextparam = &method->param[0];
 157             }
 158         }
 159         ++state->msp;
 160         if (state->msp >= state->mstack_alloc)
 161         {
 162             state->mstack_alloc += 10;
 163             srenew(state->mstack, state->mstack_alloc);
 164         }
 165         state->mstack[state->msp] = method;
 166         if (method->flags & SMETH_MODIFIER)
 167         {
 168             return MODIFIER;
 169         }
 170         switch (method->type)
 171         {
 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;
 176             default:
 177                 --state->msp;
 178                 GMX_THROW(gmx::InternalError("Unsupported method type"));
 179         }
 180     }
 181 }
 182
 183 int
 184 _gmx_sel_lexer_process_pending(YYSTYPE *yylval, YYLTYPE *yylloc,
 185                                gmx_sel_lexer_t *state)
 186 {
 187     if (state->nextparam)
 188     {
 189         gmx_ana_selparam_t *param   = state->nextparam;
 190         bool                bBoolNo = state->bBoolNo;
 191
 192         if (state->neom > 0)
 193         {
 194             --state->neom;
 195             _gmx_sel_lexer_add_token(yylloc, nullptr, 0, state);
 196             return END_OF_METHOD;
 197         }
 198         state->nextparam = nullptr;
 199         state->bBoolNo   = false;
 200         _gmx_sel_lexer_add_token(yylloc, param->name, -1, state);
 201         return init_param_token(yylval, param, bBoolNo);
 202     }
 203     if (state->prev_pos_kw > 0)
 204     {
 205         --state->prev_pos_kw;
 206     }
 207     if (state->nextMethodSymbol)
 208     {
 209         const gmx::SelectionParserSymbol *symbol = state->nextMethodSymbol;
 210         state->nextMethodSymbol = nullptr;
 211         return init_method_token(yylval, yylloc, symbol, true, state);
 212     }
 213     return 0;
 214 }
 215
 216 int
 217 _gmx_sel_lexer_process_identifier(YYSTYPE *yylval, YYLTYPE *yylloc,
 218                                   char *yytext, size_t yyleng,
 219                                   gmx_sel_lexer_t *state)
 220 {
 221     /* Check if the identifier matches with a parameter name */
 222     if (state->msp >= 0)
 223     {
 224         gmx_ana_selparam_t *param   = nullptr;
 225         bool                bBoolNo = false;
 226         int                 sp      = state->msp;
 227         while (!param && sp >= 0)
 228         {
 229             int             i;
 230             for (i = 0; i < state->mstack[sp]->nparams; ++i)
 231             {
 232                 /* Skip NULL parameters and too long parameters */
 233                 if (state->mstack[sp]->param[i].name == nullptr
 234                     || strlen(state->mstack[sp]->param[i].name) > yyleng)
 235                 {
 236                     continue;
 237                 }
 238                 if (!strncmp(state->mstack[sp]->param[i].name, yytext, yyleng))
 239                 {
 240                     param = &state->mstack[sp]->param[i];
 241                     break;
 242                 }
 243                 /* Check separately for a 'no' prefix on boolean parameters */
 244                 if (state->mstack[sp]->param[i].val.type == NO_VALUE
 245                     && yyleng > 2 && yytext[0] == 'n' && yytext[1] == 'o'
 246                     && !strncmp(state->mstack[sp]->param[i].name, yytext+2, yyleng-2))
 247                 {
 248                     param   = &state->mstack[sp]->param[i];
 249                     bBoolNo = true;
 250                     break;
 251                 }
 252             }
 253             if (!param)
 254             {
 255                 --sp;
 256             }
 257         }
 258         if (param)
 259         {
 260             if (param->val.type == NO_VALUE && !bBoolNo)
 261             {
 262                 state->bMatchBool = true;
 263             }
 264             if (sp < state->msp)
 265             {
 266                 state->neom      = state->msp - sp - 1;
 267                 state->nextparam = param;
 268                 state->bBoolNo   = bBoolNo;
 269                 return END_OF_METHOD;
 270             }
 271             _gmx_sel_lexer_add_token(yylloc, param->name, -1, state);
 272             return init_param_token(yylval, param, bBoolNo);
 273         }
 274     }
 275
 276     /* Check if the identifier matches with a symbol */
 277     const gmx::SelectionParserSymbol *symbol
 278         = state->sc->symtab->findSymbol(std::string(yytext, yyleng));
 279     /* If there is no match, return the token as a string */
 280     if (!symbol)
 281     {
 282         yylval->str = gmx_strndup(yytext, yyleng);
 283         _gmx_sel_lexer_add_token(yylloc, yytext, yyleng, state);
 284         return IDENTIFIER;
 285     }
 286     gmx::SelectionParserSymbol::SymbolType symtype = symbol->type();
 287     /* For method symbols, we need some extra processing. */
 288     if (symtype == gmx::SelectionParserSymbol::MethodSymbol)
 289     {
 290         return init_method_token(yylval, yylloc, symbol, state->prev_pos_kw > 0, state);
 291     }
 292     _gmx_sel_lexer_add_token(yylloc, symbol->name().c_str(), -1, state);
 293     /* Reserved symbols should have been caught earlier */
 294     if (symtype == gmx::SelectionParserSymbol::ReservedSymbol)
 295     {
 296         GMX_THROW(gmx::InternalError(gmx::formatString(
 297                                              "Mismatch between tokenizer and reserved symbol table (for '%s')",
 298                                              symbol->name().c_str())));
 299     }
 300     /* For variable symbols, return the type of the variable value */
 301     if (symtype == gmx::SelectionParserSymbol::VariableSymbol)
 302     {
 303         const gmx::SelectionTreeElementPointer &var = symbol->variableValue();
 304         /* Return simple tokens for constant variables */
 305         if (var->type == SEL_CONST)
 306         {
 307             switch (var->v.type)
 308             {
 309                 case INT_VALUE:
 310                     yylval->i = var->v.u.i[0];
 311                     return TOK_INT;
 312                 case REAL_VALUE:
 313                     yylval->r = var->v.u.r[0];
 314                     return TOK_REAL;
 315                 case POS_VALUE:
 316                     break;
 317                 default:
 318                     GMX_THROW(gmx::InternalError("Unsupported variable type"));
 319             }
 320         }
 321         yylval->sel = new gmx::SelectionTreeElementPointer(var);
 322         switch (var->v.type)
 323         {
 324             case INT_VALUE:   return VARIABLE_NUMERIC;
 325             case REAL_VALUE:  return VARIABLE_NUMERIC;
 326             case POS_VALUE:   return VARIABLE_POS;
 327             case GROUP_VALUE: return VARIABLE_GROUP;
 328             default:
 329                 delete yylval->sel;
 330                 GMX_THROW(gmx::InternalError("Unsupported variable type"));
 331         }
 332         /* This position should not be reached. */
 333     }
 334     /* For position symbols, we need to return KEYWORD_POS, but we also need
 335      * some additional handling. */
 336     if (symtype == gmx::SelectionParserSymbol::PositionSymbol)
 337     {
 338         state->bMatchOf    = true;
 339         yylval->str        = gmx_strdup(symbol->name().c_str());
 340         state->prev_pos_kw = 2;
 341         return KEYWORD_POS;
 342     }
 343     /* Should not be reached */
 344     return INVALID;
 345 }
 346
 347 void
 348 _gmx_sel_lexer_add_token(YYLTYPE *yylloc, const char *str, int len,
 349                          gmx_sel_lexer_t *state)
 350 {
 351     yylloc->startIndex = yylloc->endIndex = state->pselstr.size();
 352     /* Do nothing if the string is empty, or if it is a space and there is
 353      * no other text yet, or if there already is a space. */
 354     if (!str || len == 0 || strlen(str) == 0
 355         || (str[0] == ' ' && str[1] == 0
 356             && (state->pselstr.empty() || state->pselstr.back() == ' ')))
 357     {
 358         return;
 359     }
 360     if (len < 0)
 361     {
 362         len = strlen(str);
 363     }
 364     /* Append the token to the stored string */
 365     state->pselstr.append(str, len);
 366     yylloc->endIndex = state->pselstr.size();
 367 }
 368
 369 void
 370 _gmx_sel_init_lexer(yyscan_t *scannerp, struct gmx_ana_selcollection_t *sc,
 371                     gmx::TextWriter *statusWriter, int maxnr,
 372                     bool bGroups, struct gmx_ana_indexgrps_t *grps)
 373 {
 374     int rc = _gmx_sel_yylex_init(scannerp);
 375     if (rc != 0)
 376     {
 377         // TODO: Throw a more representative exception.
 378         GMX_THROW(gmx::InternalError("Lexer initialization failed"));
 379     }
 380
 381     gmx_sel_lexer_t *state = new gmx_sel_lexer_t;
 382
 383     state->sc        = sc;
 384     state->bGroups   = bGroups;
 385     state->grps      = grps;
 386     state->nexpsel   = (maxnr > 0 ? static_cast<int>(sc->sel.size()) + maxnr : -1);
 387
 388     state->statusWriter = statusWriter;
 389
 390     state->currentLocation.startIndex = 0;
 391     state->currentLocation.endIndex   = 0;
 392
 393     snew(state->mstack, 20);
 394     state->mstack_alloc     = 20;
 395     state->msp              = -1;
 396     state->neom             = 0;
 397     state->nextparam        = nullptr;
 398     state->nextMethodSymbol = nullptr;
 399     state->prev_pos_kw      = 0;
 400     state->bBoolNo          = false;
 401     state->bMatchOf         = false;
 402     state->bMatchBool       = false;
 403     state->bCmdStart        = true;
 404     state->bBuffer          = false;
 405
 406     _gmx_sel_yyset_extra(state, *scannerp);
 407 }
 408
 409 void
 410 _gmx_sel_free_lexer(yyscan_t scanner)
 411 {
 412     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 413
 414     sfree(state->mstack);
 415     if (state->bBuffer)
 416     {
 417         _gmx_sel_yy_delete_buffer(state->buffer, scanner);
 418     }
 419     delete state;
 420     _gmx_sel_yylex_destroy(scanner);
 421 }
 422
 423 void
 424 _gmx_sel_lexer_set_exception(yyscan_t                  scanner,
 425                              const std::exception_ptr &ex)
 426 {
 427     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 428     state->exception = ex;
 429 }
 430
 431 void
 432 _gmx_sel_lexer_rethrow_exception_if_occurred(yyscan_t scanner)
 433 {
 434     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 435     if (state->exception)
 436     {
 437         std::exception_ptr ex = state->exception;
 438         state->exception = std::exception_ptr();
 439         std::rethrow_exception(ex);
 440     }
 441 }
 442
 443 gmx::TextWriter *
 444 _gmx_sel_lexer_get_status_writer(yyscan_t scanner)
 445 {
 446     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 447     return state->statusWriter;
 448 }
 449
 450 struct gmx_ana_selcollection_t *
 451 _gmx_sel_lexer_selcollection(yyscan_t scanner)
 452 {
 453     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 454     return state->sc;
 455 }
 456
 457 bool
 458 _gmx_sel_lexer_has_groups_set(yyscan_t scanner)
 459 {
 460     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 461     return state->bGroups;
 462 }
 463
 464 struct gmx_ana_indexgrps_t *
 465 _gmx_sel_lexer_indexgrps(yyscan_t scanner)
 466 {
 467     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 468     return state->grps;
 469 }
 470
 471 int
 472 _gmx_sel_lexer_exp_selcount(yyscan_t scanner)
 473 {
 474     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 475     return state->nexpsel;
 476 }
 477
 478 const char *
 479 _gmx_sel_lexer_pselstr(yyscan_t scanner)
 480 {
 481     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 482     return state->pselstr.c_str();
 483 }
 484
 485 void
 486 _gmx_sel_lexer_set_current_location(yyscan_t                      scanner,
 487                                     const gmx::SelectionLocation &location)
 488 {
 489     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 490     state->currentLocation = location;
 491 }
 492
 493 const gmx::SelectionLocation &
 494 _gmx_sel_lexer_get_current_location(yyscan_t scanner)
 495 {
 496     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 497     return state->currentLocation;
 498 }
 499
 500 std::string
 501 _gmx_sel_lexer_get_current_text(yyscan_t scanner)
 502 {
 503     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 504     return _gmx_sel_lexer_get_text(scanner, state->currentLocation);
 505 }
 506
 507 std::string
 508 _gmx_sel_lexer_get_text(yyscan_t                      scanner,
 509                         const gmx::SelectionLocation &location)
 510 {
 511     gmx_sel_lexer_t *state      = _gmx_sel_yyget_extra(scanner);
 512     const int        startIndex = location.startIndex;
 513     const int        endIndex   = location.endIndex;
 514     if (startIndex >= endIndex)
 515     {
 516         return std::string();
 517     }
 518     return state->pselstr.substr(startIndex, endIndex - startIndex);
 519 }
 520
 521 void
 522 _gmx_sel_lexer_clear_pselstr(yyscan_t scanner)
 523 {
 524     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 525     state->pselstr.clear();
 526 }
 527
 528 void
 529 _gmx_sel_lexer_clear_method_stack(yyscan_t scanner)
 530 {
 531     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 532
 533     state->msp = -1;
 534 }
 535
 536 void
 537 _gmx_sel_finish_method(yyscan_t scanner)
 538 {
 539     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 540
 541     if (state->msp >= 0)
 542     {
 543         --state->msp;
 544     }
 545 }
 546
 547 void
 548 _gmx_sel_set_lex_input_file(yyscan_t scanner, FILE *fp)
 549 {
 550     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 551
 552     state->bBuffer = true;
 553     state->buffer  = _gmx_sel_yy_create_buffer(fp, YY_BUF_SIZE, scanner);
 554     _gmx_sel_yy_switch_to_buffer(state->buffer, scanner);
 555 }
 556
 557 void
 558 _gmx_sel_set_lex_input_str(yyscan_t scanner, const char *str)
 559 {
 560     gmx_sel_lexer_t *state = _gmx_sel_yyget_extra(scanner);
 561
 562     if (state->bBuffer)
 563     {
 564         _gmx_sel_yy_delete_buffer(state->buffer, scanner);
 565     }
 566     state->bBuffer = true;
 567     state->buffer  = _gmx_sel_yy_scan_string(str, scanner);
 568 }