src/language/lexer/lexer.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2010 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 #if !lexer_h
  18 #define lexer_h 1
  19
  20 #include <ctype.h>
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include <data/identifier.h>
  24 #include <data/variable.h>
  25 #include <libpspp/getl.h>
  26
  27 struct lexer;
  28
  29 /* Initialization. */
  30 struct lexer * lex_create (struct source_stream *);
  31 void lex_destroy (struct lexer *);
  32
  33 /* State accessors */
  34 struct source_stream * lex_get_source_stream (const struct lexer *);
  35 enum syntax_mode lex_current_syntax_mode (const struct lexer *);
  36 enum error_mode lex_current_error_mode (const struct lexer *);
  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 bool lex_is_string (struct lexer *);
  51
  52
  53 /* Token matching functions. */
  54 bool lex_match (struct lexer *, enum token_type);
  55 bool lex_match_id (struct lexer *, const char *);
  56 bool lex_match_id_n (struct lexer *, const char *, size_t n);
  57 bool lex_match_int (struct lexer *, int);
  58 bool lex_match_hyphenated_word (struct lexer *lexer, const char *s);
  59
  60
  61 /* Forcible matching functions. */
  62 bool lex_force_match (struct lexer *, enum token_type);
  63 bool lex_force_match_id (struct lexer *, const char *);
  64 bool lex_force_int (struct lexer *);
  65 bool lex_force_num (struct lexer *);
  66 bool lex_force_id (struct lexer *);
  67 bool lex_force_string (struct lexer *);
  68
  69 /* Weird token functions. */
  70 enum token_type lex_look_ahead (struct lexer *);
  71 void lex_put_back (struct lexer *, enum token_type);
  72
  73 /* Weird line processing functions. */
  74 const char *lex_entire_line (const struct lexer *);
  75 const struct string *lex_entire_line_ds (const struct lexer *);
  76 const char *lex_rest_of_line (const struct lexer *);
  77 bool lex_end_dot (const struct lexer *);
  78 void lex_preprocess_line (struct string *, enum syntax_mode,
  79                           bool *line_starts_command,
  80                           bool *line_ends_command);
  81 void lex_discard_line (struct lexer *);
  82 void lex_discard_rest_of_command (struct lexer *);
  83
  84 /* Weird line reading functions. */
  85 bool lex_get_line (struct lexer *);
  86 bool lex_get_line_raw (struct lexer *);
  87
  88 /* Token names. */
  89 const char *lex_token_name (enum token_type);
  90 char *lex_token_representation (struct lexer *);
  91
  92 /* Token accessors */
  93 enum token_type lex_token (const struct lexer *);
  94 double lex_tokval (const struct lexer *);
  95 const char *lex_tokcstr (const struct lexer *);
  96 struct substring lex_tokss (const struct lexer *);
  97
  98 /* Really weird functions. */
  99 void lex_skip_comment (struct lexer *);
 100
 101 #endif /* !lexer_h */