pintos-os.org Git - pspp/blob - src/language/lexer/lexer.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2010, 2011, 2013, 2014 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 LEXER_H
  18 #define LEXER_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22 #include <unistd.h>
  23
  24 #include "data/identifier.h"
  25 #include "data/variable.h"
  26 #include "libpspp/compiler.h"
  27 #include "libpspp/prompt.h"
  28
  29 struct lexer;
  30
  31 /* The syntax mode for which a syntax file is intended. */
  32 enum lex_syntax_mode
  33   {
  34     LEX_SYNTAX_AUTO,            /* Try to guess intent. */
  35     LEX_SYNTAX_INTERACTIVE,     /* Interactive mode. */
  36     LEX_SYNTAX_BATCH            /* Batch mode. */
  37   };
  38
  39 /* Handling of errors. */
  40 enum lex_error_mode
  41   {
  42     LEX_ERROR_TERMINAL,        /* Discard input line and continue reading. */
  43     LEX_ERROR_CONTINUE,        /* Continue to next command, except for
  44                                   cascading failures. */
  45     LEX_ERROR_STOP             /* Stop processing. */
  46   };
  47
  48 /* Reads a single syntax file as a stream of bytes encoded in UTF-8.
  49
  50    Not opaque. */
  51 struct lex_reader
  52   {
  53     const struct lex_reader_class *class;
  54     enum lex_syntax_mode syntax;
  55     enum lex_error_mode error;
  56     char *file_name;            /* NULL if not associated with a file. */
  57     int line_number;            /* 1-based initial line number, 0 if none. */
  58   };
  59
  60 /* An implementation of a lex_reader. */
  61 struct lex_reader_class
  62   {
  63     /* Reads up to N bytes of data from READER into N.  Returns the positive
  64        number of bytes read if successful, or zero at end of input or on
  65        error.
  66
  67        STYLE provides a hint to interactive readers as to what kind of syntax
  68        is being read right now. */
  69     size_t (*read) (struct lex_reader *reader, char *buf, size_t n,
  70                     enum prompt_style style);
  71
  72     /* Closes and destroys READER, releasing any allocated storage.
  73
  74        The caller will free the 'file_name' member of READER, so the
  75        implementation should not do so. */
  76     void (*destroy) (struct lex_reader *reader);
  77   };
  78
  79 /* Helper functions for lex_reader. */
  80 void lex_reader_init (struct lex_reader *, const struct lex_reader_class *);
  81 void lex_reader_set_file_name (struct lex_reader *, const char *file_name);
  82
  83 /* Creating various kinds of lex_readers. */
  84 struct lex_reader *lex_reader_for_file (const char *file_name,
  85                                         const char *encoding,
  86                                         enum lex_syntax_mode syntax,
  87                                         enum lex_error_mode error);
  88 struct lex_reader *lex_reader_for_string (const char *);
  89 struct lex_reader *lex_reader_for_format (const char *, ...)
  90   PRINTF_FORMAT (1, 2);
  91 struct lex_reader *lex_reader_for_substring_nocopy (struct substring);
  92
  93 /* Initialization. */
  94 struct lexer *lex_create (void);
  95 void lex_destroy (struct lexer *);
  96
  97 /* Files. */
  98 void lex_include (struct lexer *, struct lex_reader *);
  99 void lex_append (struct lexer *, struct lex_reader *);
 100
 101 /* Advancing. */
 102 void lex_get (struct lexer *);
 103
 104 /* Token testing functions. */
 105 bool lex_is_number (struct lexer *);
 106 double lex_number (struct lexer *);
 107 bool lex_is_integer (struct lexer *);
 108 long lex_integer (struct lexer *);
 109 bool lex_is_string (struct lexer *);
 110
 111 /* Token testing functions with lookahead. */
 112 bool lex_next_is_number (struct lexer *, int n);
 113 double lex_next_number (struct lexer *, int n);
 114 bool lex_next_is_integer (struct lexer *, int n);
 115 long lex_next_integer (struct lexer *, int n);
 116 bool lex_next_is_string (struct lexer *, int n);
 117
 118 /* Token matching functions. */
 119 bool lex_match (struct lexer *, enum token_type);
 120 bool lex_match_id (struct lexer *, const char *);
 121 bool lex_match_id_n (struct lexer *, const char *, size_t n);
 122 bool lex_match_int (struct lexer *, int);
 123 bool lex_match_phrase (struct lexer *, const char *s);
 124
 125 /* Forcible matching functions. */
 126 bool lex_force_match (struct lexer *, enum token_type);
 127 bool lex_force_match_id (struct lexer *, const char *);
 128 bool lex_force_int (struct lexer *);
 129 bool lex_force_num (struct lexer *);
 130 bool lex_force_id (struct lexer *);
 131 bool lex_force_string (struct lexer *);
 132 bool lex_force_string_or_id (struct lexer *);
 133
 134 /* Token accessors. */
 135 enum token_type lex_token (const struct lexer *);
 136 double lex_tokval (const struct lexer *);
 137 const char *lex_tokcstr (const struct lexer *);
 138 struct substring lex_tokss (const struct lexer *);
 139
 140 /* Looking ahead. */
 141 const struct token *lex_next (const struct lexer *, int n);
 142 enum token_type lex_next_token (const struct lexer *, int n);
 143 const char *lex_next_tokcstr (const struct lexer *, int n);
 144 double lex_next_tokval (const struct lexer *, int n);
 145 struct substring lex_next_tokss (const struct lexer *, int n);
 146
 147 /* Current position. */
 148 int lex_get_first_line_number (const struct lexer *, int n);
 149 int lex_get_last_line_number (const struct lexer *, int n);
 150 int lex_get_first_column (const struct lexer *, int n);
 151 int lex_get_last_column (const struct lexer *, int n);
 152 const char *lex_get_file_name (const struct lexer *);
 153
 154 /* Issuing errors. */
 155 void lex_error (struct lexer *, const char *, ...) PRINTF_FORMAT (2, 3);
 156 void lex_next_error (struct lexer *, int n0, int n1, const char *, ...)
 157   PRINTF_FORMAT (4, 5);
 158 int lex_end_of_command (struct lexer *);
 159
 160 void lex_error_expecting (struct lexer *, const char *, ...) SENTINEL(0);
 161
 162 void lex_sbc_only_once (const char *);
 163 void lex_sbc_missing (const char *);
 164
 165 void lex_spec_only_once (struct lexer *, const char *subcommand,
 166                          const char *specification);
 167 void lex_spec_missing (struct lexer *, const char *subcommand,
 168                        const char *specification);
 169
 170 void lex_error_valist (struct lexer *, const char *, va_list)
 171   PRINTF_FORMAT (2, 0);
 172 void lex_next_error_valist (struct lexer *lexer, int n0, int n1,
 173                             const char *format, va_list)
 174   PRINTF_FORMAT (4, 0);
 175
 176 /* Error handling. */
 177 enum lex_syntax_mode lex_get_syntax_mode (const struct lexer *);
 178 enum lex_error_mode lex_get_error_mode (const struct lexer *);
 179 void lex_discard_rest_of_command (struct lexer *);
 180 void lex_interactive_reset (struct lexer *);
 181 void lex_discard_noninteractive (struct lexer *);
 182
 183 #endif /* lexer.h */