Refactor for testing interactive selection input
[alexxy/gromacs.git] / src / gromacs / selection / scanner_internal.h
index 3a280b31ceb5c8c8b90c30fc2c60d77bcadb6e42..7b01b81e27346ea116fa2a2d81c63e51ab1cb9ea 100644 (file)
@@ -1,52 +1,55 @@
 /*
+ * This file is part of the GROMACS molecular simulation package.
  *
- *                This source code is part of
+ * Copyright (c) 2009,2010,2011,2012,2014,2015, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
  *
- *                 G   R   O   M   A   C   S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
  *
- *          GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  *
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
  *
  * To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
  */
 /*! \internal \file
  * \brief Internal header file used by the selection tokenizer.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \ingroup module_selection
  */
 #ifndef SELECTION_SCANNER_INTERNAL_H
 #define SELECTION_SCANNER_INTERNAL_H
 
-namespace gmx
-{
-class MessageStringCollector;
-}
+#include <boost/exception_ptr.hpp>
 
 #include "parser.h"
 
-/** The scanning function generated by Flex. */
-#define YY_DECL int _gmx_sel_yylex(YYSTYPE *yylval, yyscan_t yyscanner)
-YY_DECL;
+namespace gmx
+{
+class SelectionParserSymbol;
+class TextWriter;
+}
 
 /* These need to be defined before including scanner_flex.h, because it
  * uses YY_EXTRA_TYPE. But we also need to include it before defining
@@ -70,8 +73,8 @@ typedef struct gmx_sel_lexer_t
 {
     //! Selection collection to put parsed selections in.
     struct gmx_ana_selcollection_t  *sc;
-    //! Error reporter object.
-    gmx::MessageStringCollector     *errors;
+    //! Stores an exception that occurred during parsing.
+    boost::exception_ptr             exception;
     //! Whether external index groups have been set.
     bool                             bGroups;
     //! External index groups for resolving \c group keywords.
@@ -79,12 +82,8 @@ typedef struct gmx_sel_lexer_t
     //! Number of selections at which the parser should stop.
     int                              nexpsel;
 
-    //! Whether the parser is interactive.
-    bool                             bInteractive;
-    //! Current input string (line) for an interactive scanner.
-    char                            *inputstr;
-    //! Number of bytes allocated for \a inputstr.
-    int                              nalloc_input;
+    //! Writer to use for status output (if not NULL, parser is interactive).
+    gmx::TextWriter                 *statusWriter;
 
     //! Pretty-printed version of the string parsed since last clear.
     char                            *pselstr;
@@ -92,6 +91,13 @@ typedef struct gmx_sel_lexer_t
     int                              pslen;
     //! Number of bytes allocated for \a pselstr.
     int                              nalloc_psel;
+    /*! \brief
+     * Position of the result of the current Bison action.
+     *
+     * This identifies the part of \a pselstr that corresponds to the
+     * subselection that is currently being reduced by Bison.
+     */
+    gmx::SelectionLocation           currentLocation;
 
     //! Stack of methods in which parameters should be looked up.
     struct gmx_ana_selmethod_t     **mstack;
@@ -111,9 +117,9 @@ typedef struct gmx_sel_lexer_t
      *
      * Only used when \p nextparam is NULL.
      */
-    struct gmx_ana_selmethod_t      *nextmethod;
+    const gmx::SelectionParserSymbol *nextMethodSymbol;
     //! Used to track whether the previous token was a position modifier.
-    int                              prev_pos_kw;
+    int                               prev_pos_kw;
 
     //! Whether the 'of' keyword is acceptable as the next token.
     bool                             bMatchOf;
@@ -133,13 +139,13 @@ typedef struct gmx_sel_lexer_t
  * we cannot have them here as parameter names... */
 /** Internal function for cases where several tokens need to be returned. */
 int
-_gmx_sel_lexer_process_pending(YYSTYPE *, gmx_sel_lexer_t *state);
+_gmx_sel_lexer_process_pending(YYSTYPE *, YYLTYPE *, gmx_sel_lexer_t *state);
 /** Internal function that processes identifier tokens. */
 int
-_gmx_sel_lexer_process_identifier(YYSTYPE *, char *, size_t,
-                                  gmx_sel_lexer_t *state);
+    _gmx_sel_lexer_process_identifier(YYSTYPE *, YYLTYPE *, char *, size_t,
+                                      gmx_sel_lexer_t *state);
 /** Internal function to add a token to the pretty-printed selection text. */
 void
-_gmx_sel_lexer_add_token(const char *str, int len, gmx_sel_lexer_t *state);
+_gmx_sel_lexer_add_token(YYLTYPE *, const char *str, int len, gmx_sel_lexer_t *state);
 
 #endif