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