src/gromacs/selection/scanner_internal.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2012,2014,2015,2016, 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 Internal header file used by the selection tokenizer.
  37  *
  38  * \author Teemu Murtola <teemu.murtola@gmail.com>
  39  * \ingroup module_selection
  40  */
  41 #ifndef SELECTION_SCANNER_INTERNAL_H
  42 #define SELECTION_SCANNER_INTERNAL_H
  43
  44 #include <exception>
  45 #include <string>
  46
  47 #include "parser.h"
  48
  49 namespace gmx
  50 {
  51 class SelectionParserSymbol;
  52 class TextWriter;
  53 }
  54
  55 /* These need to be defined before including scanner_flex.h, because it
  56  * uses YY_EXTRA_TYPE. But we also need to include it before defining
  57  * gmx_sel_lexer_t; hence the forward declaration. */
  58 struct gmx_sel_lexer_t;
  59 #define YY_EXTRA_TYPE struct gmx_sel_lexer_t *
  60
  61 /* We cannot include scanner_flex.h from the scanner itself, because it
  62  * seems to break everything. */
  63 /* And we need to define YY_NO_UNISTD_H here as well, otherwise unistd.h
  64  * gets included in other files than scanner.cpp... */
  65 #ifndef FLEX_SCANNER
  66 #define YY_NO_UNISTD_H
  67 #include "scanner_flex.h"
  68 #endif
  69
  70 /*! \internal \brief
  71  * Internal data structure for the selection tokenizer state.
  72  */
  73 typedef struct gmx_sel_lexer_t
  74 {
  75     //! Selection collection to put parsed selections in.
  76     struct gmx_ana_selcollection_t  *sc;
  77     //! Stores an exception that occurred during parsing.
  78     std::exception_ptr               exception;
  79     //! Whether external index groups have been set.
  80     bool                             bGroups;
  81     //! External index groups for resolving \c group keywords.
  82     struct gmx_ana_indexgrps_t      *grps;
  83     //! Number of selections at which the parser should stop.
  84     int                              nexpsel;
  85
  86     //! Writer to use for status output (if not NULL, parser is interactive).
  87     gmx::TextWriter                 *statusWriter;
  88
  89     //! Pretty-printed version of the string parsed since last clear.
  90     std::string                      pselstr;
  91     /*! \brief
  92      * Position of the result of the current Bison action.
  93      *
  94      * This identifies the part of \a pselstr that corresponds to the
  95      * subselection that is currently being reduced by Bison.
  96      */
  97     gmx::SelectionLocation           currentLocation;
  98
  99     //! Stack of methods in which parameters should be looked up.
 100     struct gmx_ana_selmethod_t     **mstack;
 101     //! Index of the top of the stack in \a mstack.
 102     int                              msp;
 103     //! Number of elements allocated for \a mstack.
 104     int                              mstack_alloc;
 105
 106     //! Number of END_OF_METHOD tokens to return before \a nextparam.
 107     int                              neom;
 108     //! Parameter symbol to return before resuming scanning.
 109     struct gmx_ana_selparam_t       *nextparam;
 110     //! Whether \a nextparam was a boolean parameter with a 'no' prefix.
 111     bool                             bBoolNo;
 112     /*! \brief
 113      * Method symbol to return before resuming scanning
 114      *
 115      * Only used when \p nextparam is NULL.
 116      */
 117     const gmx::SelectionParserSymbol *nextMethodSymbol;
 118     //! Used to track whether the previous token was a position modifier.
 119     int                               prev_pos_kw;
 120
 121     //! Whether the 'of' keyword is acceptable as the next token.
 122     bool                             bMatchOf;
 123     //! Whether boolean values (yes/no/on/off) are acceptable as the next token.
 124     bool                             bMatchBool;
 125     //! Whether the next token starts a new selection.
 126     bool                             bCmdStart;
 127
 128     //! Whether an external buffer is set for the scanner.
 129     bool                             bBuffer;
 130     //! The current buffer for the scanner.
 131     YY_BUFFER_STATE                  buffer;
 132 } gmx_sel_lexer_t;
 133
 134 /* Because Flex defines yylval, yytext, and yyleng as macros,
 135  * and this file is included from scanner.l,
 136  * we cannot have them here as parameter names... */
 137 /** Internal function for cases where several tokens need to be returned. */
 138 int
 139 _gmx_sel_lexer_process_pending(YYSTYPE *, YYLTYPE *, gmx_sel_lexer_t *state);
 140 /** Internal function that processes identifier tokens. */
 141 int
 142     _gmx_sel_lexer_process_identifier(YYSTYPE *, YYLTYPE *, char *, size_t,
 143                                       gmx_sel_lexer_t *state);
 144 /** Internal function to add a token to the pretty-printed selection text. */
 145 void
 146 _gmx_sel_lexer_add_token(YYLTYPE *, const char *str, int len, gmx_sel_lexer_t *state);
 147
 148 #endif