lexer: Factor some token inspectors out into new token functions.
[pspp] / 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 <stdbool.h>
21 #include <stdio.h>
22 #include "libpspp/assertion.h"
23 #include "libpspp/str.h"
24 #include "data/identifier.h"
25
26 /* A PSPP syntax token.
27
28    The 'type' member is used by the scanner (see scan.h) for SCAN_* values as
29    well, which is why it is not declared as type "enum token_type". */
30 struct token
31   {
32     int type;                   /* Usually a "enum token_type" value. */
33     double number;
34     struct substring string;
35   };
36
37 void token_copy (struct token *, const struct token *);
38 void token_uninit (struct token *);
39
40 bool token_equal (const struct token *, const struct token *);
41
42 char *token_to_string (const struct token *);
43
44 void token_print (const struct token *, FILE *);
45
46 static inline bool token_is_number (const struct token *);
47 static inline double token_number (const struct token *);
48 bool token_is_integer (const struct token *);
49 long token_integer (const struct token *);
50 static inline bool token_is_string (const struct token *);
51
52 static inline bool
53 token_is_number (const struct token *t)
54 {
55   return t->type == T_POS_NUM || t->type == T_NEG_NUM;
56 }
57
58 static inline double
59 token_number (const struct token *t)
60 {
61   assert (token_is_number (t));
62   return t->number;
63 }
64
65 static inline bool
66 token_is_string (const struct token *t)
67 {
68   return t->type == T_STRING;
69 }
70 \f
71 struct tokens
72   {
73     struct token *tokens;
74     size_t n;
75     size_t allocated;
76   };
77
78 void tokens_copy (struct tokens *, const struct tokens *);
79 void tokens_uninit (struct tokens *);
80 void tokens_add (struct tokens *, const struct token *);
81
82 void tokens_print (const struct tokens *, FILE *);
83
84 #endif /* token.h */