scan: New library for high-level PSPP syntax lexical analysis.
[pspp-builds.git] / src / language / lexer / token.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2010, 2011 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #ifndef TOKEN_H
18 #define TOKEN_H 1
19
20 #include <stdio.h>
21 #include "libpspp/str.h"
22 #include "data/identifier.h"
23
24 /* A PSPP syntax token.
25
26    The 'type' member is used by the scanner (see scan.h) for SCAN_* values as
27    well, which is why it is not declared as type "enum token_type". */
28 struct token
29   {
30     int type;                   /* Usually a "enum token_type" value. */
31     double number;
32     struct substring string;
33   };
34
35 #define TOKEN_INITIALIZER(TYPE, NUMBER, STRING) \
36         { TYPE, NUMBER, SS_LITERAL_INITIALIZER (STRING) }
37
38 void token_init (struct token *);
39 void token_destroy (struct token *);
40
41 char *token_to_string (const struct token *);
42
43 void token_print (const struct token *, FILE *);
44
45 #endif /* token.h */