Replace more uses of 'cnt' by 'n'.
[pspp] / src / language / lexer / variable-parser.h
index 08c9902d8c591da7a9cd8969263156ab2c86c193..66e8efab6c58cd5b17f5e2c0ed0778296f0959de 100644 (file)
@@ -1,20 +1,18 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 1997-9, 2000, 2006, 2007 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 1997-9, 2000, 2006, 2007, 2010 Free Software Foundation, Inc.
 
-   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.
+   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 3 of the License, or
+   (at your option) any later version.
 
-   This program 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
-   General Public License for more details.
+   This program 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 General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #ifndef VARIABLE_PARSER_H
 #define VARIABLE_PARSER_H 1
@@ -33,7 +31,7 @@ struct var_set *var_set_create_from_dict (const struct dictionary *d);
 struct var_set *var_set_create_from_array (struct variable *const *var,
                                            size_t);
 
-size_t var_set_get_cnt (const struct var_set *vs);
+size_t var_set_get_n (const struct var_set *vs);
 
 void var_set_destroy (struct var_set *vs);
 
@@ -61,15 +59,36 @@ bool parse_variables_pool (struct lexer *, struct pool *, const struct dictionar
                           struct variable ***, size_t *, int opts);
 bool parse_var_set_vars (struct lexer *, const struct var_set *, struct variable ***, size_t *,
                         int opts);
-bool parse_DATA_LIST_vars (struct lexer *, char ***names, size_t *cnt, int opts);
-bool parse_DATA_LIST_vars_pool (struct lexer *, struct pool *,
-                               char ***names, size_t *cnt, int opts);
-bool parse_mixed_vars (struct lexer *, const struct dictionary *dict, 
-                      char ***names, size_t *cnt, int opts);
-bool parse_mixed_vars_pool (struct lexer *, const struct dictionary *dict, 
+
+char *parse_DATA_LIST_var (struct lexer *, const struct dictionary *);
+bool parse_DATA_LIST_vars (struct lexer *, const struct dictionary *,
+                           char ***names, size_t *n, int opts);
+bool parse_DATA_LIST_vars_pool (struct lexer *, const struct dictionary *,
+                                struct pool *,
+                                char ***names, size_t *n, int opts);
+bool parse_mixed_vars (struct lexer *, const struct dictionary *dict,
+                      char ***names, size_t *n, int opts);
+bool parse_mixed_vars_pool (struct lexer *, const struct dictionary *dict,
                            struct pool *,
-                           char ***names, size_t *cnt, int opts);
+                           char ***names, size_t *n, int opts);
+\f
+/* This variable parser supports the unusual situation where set of variables
+   has to be parsed before the associated dictionary is available.  Thus,
+   parsing proceeds in two phases: first, the variables are parsed in a vector
+   of "struct var_syntax"; second, when the dictionary becomes available, the
+   structs are turned into "struct variable"s. */
+
+struct var_syntax
+  {
+    char *first;                /* Always nonnull. */
+    char *last;                 /* Nonnull for var ranges (e.g. "a TO b"). */
+  };
+void var_syntax_destroy (struct var_syntax *, size_t n);
 
+bool var_syntax_parse (struct lexer *, struct var_syntax **, size_t *);
+bool var_syntax_evaluate (const struct var_syntax *, size_t,
+                          const struct dictionary *,
+                          struct variable ***, size_t *, int opts);
 
 /* Const wrappers */
 
@@ -122,8 +141,25 @@ parse_const_var_set_vars (struct lexer *l, const struct const_var_set *vs,
 static inline void
 const_var_set_destroy (struct const_var_set *vs)
 {
-  var_set_destroy ( (struct var_set *) vs);
+  var_set_destroy ((struct var_set *) vs);
 }
 
+/* Match a variable.
+   If the match succeeds, the variable will be placed in VAR.
+   Returns true if successful */
+bool
+lex_match_variable (struct lexer *lexer, const struct dictionary *dict, const struct variable **var);
+
+struct interaction;
+
+/* Parse an interaction.
+   If not successful return false.
+   Otherwise, a newly created interaction will be placed in IACT.
+   It is the caller's responsibility to destroy this interaction.
+ */
+bool
+parse_design_interaction (struct lexer *lexer, const struct dictionary *dict, struct interaction **iact);
+
+
 
 #endif /* variable-parser.h */