src/gromacs/selection/scanner_internal.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   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.
  13
  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.
  18  *
  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.
  25  *
  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.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief Internal header file used by the selection tokenizer.
  33  *
  34  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  35  * \ingroup module_selection
  36  */
  37 #ifndef SELECTION_SCANNER_INTERNAL_H
  38 #define SELECTION_SCANNER_INTERNAL_H
  39
  40 namespace gmx
  41 {
  42 class MessageStringCollector;
  43 }
  44
  45 #include "parser.h"
  46
  47 /** The scanning function generated by Flex. */
  48 #define YY_DECL int _gmx_sel_yylex(YYSTYPE *yylval, yyscan_t yyscanner)
  49 YY_DECL;
  50
  51 /* These need to be defined before including scanner_flex.h, because it
  52  * uses YY_EXTRA_TYPE. But we also need to include it before defining
  53  * gmx_sel_lexer_t; hence the forward declaration. */
  54 struct gmx_sel_lexer_t;
  55 #define YY_EXTRA_TYPE struct gmx_sel_lexer_t *
  56
  57 /* We cannot include scanner_flex.h from the scanner itself, because it
  58  * seems to break everything. */
  59 /* And we need to define YY_NO_UNISTD_H here as well, otherwise unistd.h
  60  * gets included in other files than scanner.cpp... */
  61 #ifndef FLEX_SCANNER
  62 #define YY_NO_UNISTD_H
  63 #include "scanner_flex.h"
  64 #endif
  65
  66 /*! \internal \brief
  67  * Internal data structure for the selection tokenizer state.
  68  */
  69 typedef struct gmx_sel_lexer_t
  70 {
  71     //! Selection collection to put parsed selections in.
  72     struct gmx_ana_selcollection_t  *sc;
  73     //! Error reporter object.
  74     gmx::MessageStringCollector     *errors;
  75     //! Whether external index groups have been set.
  76     bool                             bGroups;
  77     //! External index groups for resolving \c group keywords.
  78     struct gmx_ana_indexgrps_t      *grps;
  79     //! Number of selections at which the parser should stop.
  80     int                              nexpsel;
  81
  82     //! Whether the parser is interactive.
  83     bool                             bInteractive;
  84     //! Current input string (line) for an interactive scanner.
  85     char                            *inputstr;
  86     //! Number of bytes allocated for \a inputstr.
  87     int                              nalloc_input;
  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