src/language/lexer/lexer.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    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, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17    02110-1301, USA. */
  18
  19 #if !lexer_h
  20 #define lexer_h 1
  21
  22 #include <ctype.h>
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25 #include <data/identifier.h>
  26 #include <data/variable.h>
  27 #include <libpspp/getl.h>
  28
  29 struct lexer;
  30
  31 /* Initialization. */
  32 struct lexer * lex_create (struct source_stream *);
  33 void lex_destroy (struct lexer *);
  34
  35 struct source_stream * lex_get_source_stream (const struct lexer *);
  36
  37
  38 /* Common functions. */
  39 void lex_get (struct lexer *);
  40 void lex_error (struct lexer *, const char *, ...);
  41 void lex_sbc_only_once (const char *);
  42 void lex_sbc_missing (struct lexer *, const char *);
  43 int lex_end_of_command (struct lexer *);
  44
  45 /* Token testing functions. */
  46 bool lex_is_number (struct lexer *);
  47 double lex_number (struct lexer *);
  48 bool lex_is_integer (struct lexer *);
  49 long lex_integer (struct lexer *);
  50
  51 /* Token matching functions. */
  52 bool lex_match (struct lexer *, int);
  53 bool lex_match_id (struct lexer *, const char *);
  54 bool lex_match_int (struct lexer *, int);
  55
  56 /* Forcible matching functions. */
  57 bool lex_force_match (struct lexer *, int);
  58 bool lex_force_match_id (struct lexer *, const char *);
  59 bool lex_force_int (struct lexer *);
  60 bool lex_force_num (struct lexer *);
  61 bool lex_force_id (struct lexer *);
  62 bool lex_force_string (struct lexer *);
  63
  64 /* Weird token functions. */
  65 int lex_look_ahead (struct lexer *);
  66 void lex_put_back (struct lexer *, int);
  67 void lex_put_back_id (struct lexer *, const char *tokid);
  68
  69 /* Weird line processing functions. */
  70 const char *lex_entire_line (struct lexer *);
  71 const struct string *lex_entire_line_ds (struct lexer *);
  72 const char *lex_rest_of_line (struct lexer *, int *end_dot);
  73 void lex_preprocess_line (struct string *, enum getl_syntax,
  74                           bool *line_starts_command,
  75                           bool *line_ends_command);
  76 void lex_discard_line (struct lexer *);
  77 void lex_discard_rest_of_command (struct lexer *);
  78
  79 /* Weird line reading functions. */
  80 bool lex_get_line (struct lexer *);
  81 bool lex_get_line_raw (struct lexer *, enum getl_syntax *);
  82
  83 /* Token names. */
  84 const char *lex_token_name (int);
  85 char *lex_token_representation (struct lexer *);
  86
  87 /* Token accessors */
  88 int lex_token (const struct lexer *);
  89 double lex_tokval (const struct lexer *);
  90 const char *lex_tokid (const struct lexer *);
  91 const struct string *lex_tokstr (const struct lexer *);
  92
  93 /* Really weird functions. */
  94 void lex_negative_to_dash (struct lexer *);
  95 void lex_skip_comment (struct lexer *);
  96
  97 #endif /* !lexer_h */