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, 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 <boost/exception_ptr.hpp>
  45
  46 #include "parser.h"
  47
  48 namespace gmx
  49 {
  50 class MessageStringCollector;
  51 }
  52
  53 /* These need to be defined before including scanner_flex.h, because it
  54  * uses YY_EXTRA_TYPE. But we also need to include it before defining
  55  * gmx_sel_lexer_t; hence the forward declaration. */
  56 struct gmx_sel_lexer_t;
  57 #define YY_EXTRA_TYPE struct gmx_sel_lexer_t *
  58
  59 /* We cannot include scanner_flex.h from the scanner itself, because it
  60  * seems to break everything. */
  61 /* And we need to define YY_NO_UNISTD_H here as well, otherwise unistd.h
  62  * gets included in other files than scanner.cpp... */
  63 #ifndef FLEX_SCANNER
  64 #define YY_NO_UNISTD_H
  65 #include "scanner_flex.h"
  66 #endif
  67
  68 /*! \internal \brief
  69  * Internal data structure for the selection tokenizer state.
  70  */
  71 typedef struct gmx_sel_lexer_t
  72 {
  73     //! Selection collection to put parsed selections in.
  74     struct gmx_ana_selcollection_t  *sc;
  75     //! Error reporter object.
  76     gmx::MessageStringCollector     *errors;
  77     //! Stores an exception that occurred during parsing.
  78     boost::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     //! Whether the parser is interactive.
  87     bool                             bInteractive;
  88
  89     //! Pretty-printed version of the string parsed since last clear.
  90     char                            *pselstr;
  91     //! Length of the string in \a pselstr.
  92     int                              pslen;
  93     //! Number of bytes allocated for \a pselstr.
  94     int                              nalloc_psel;
  95
  96     //! Stack of methods in which parameters should be looked up.
  97     struct gmx_ana_selmethod_t     **mstack;
  98     //! Index of the top of the stack in \a mstack.
  99     int                              msp;
 100     //! Number of elements allocated for \a mstack.
 101     int                              mstack_alloc;
 102
 103     //! Number of END_OF_METHOD tokens to return before \a nextparam.
 104     int                              neom;
 105     //! Parameter symbol to return before resuming scanning.
 106     struct gmx_ana_selparam_t       *nextparam;
 107     //! Whether \a nextparam was a boolean parameter with a 'no' prefix.
 108     bool                             bBoolNo;
 109     /*! \brief
 110      * Method symbol to return before resuming scanning
 111      *
 112      * Only used when \p nextparam is NULL.
 113      */
 114     struct gmx_ana_selmethod_t      *nextmethod;
 115     //! Used to track whether the previous token was a position modifier.
 116     int                              prev_pos_kw;
 117
 118     //! Whether the 'of' keyword is acceptable as the next token.
 119     bool                             bMatchOf;
 120     //! Whether boolean values (yes/no/on/off) are acceptable as the next token.
 121     bool                             bMatchBool;
 122     //! Whether the next token starts a new selection.
 123     bool                             bCmdStart;
 124
 125     //! Whether an external buffer is set for the scanner.
 126     bool                             bBuffer;
 127     //! The current buffer for the scanner.
 128     YY_BUFFER_STATE                  buffer;
 129 } gmx_sel_lexer_t;
 130
 131 /* Because Flex defines yylval, yytext, and yyleng as macros,
 132  * and this file is included from scanner.l,
 133  * we cannot have them here as parameter names... */
 134 /** Internal function for cases where several tokens need to be returned. */
 135 int
 136 _gmx_sel_lexer_process_pending(YYSTYPE *, gmx_sel_lexer_t *state);
 137 /** Internal function that processes identifier tokens. */
 138 int
 139     _gmx_sel_lexer_process_identifier(YYSTYPE *, char *, size_t,
 140                                       gmx_sel_lexer_t *state);
 141 /** Internal function to add a token to the pretty-printed selection text. */
 142 void
 143 _gmx_sel_lexer_add_token(const char *str, int len, gmx_sel_lexer_t *state);
 144
 145 #endif