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 *encoding;
  57     char *file_name;            /* NULL if not associated with a file. */
  58     int line_number;            /* 1-based initial line number, 0 if none. */
  59     bool eof;
  60   };
  61
  62 /* An implementation of a lex_reader. */
  63 struct lex_reader_class
  64   {
  65     /* Reads up to N bytes of data from READER into N.  Returns the positive
  66        number of bytes read if successful, or zero at end of input or on
  67        error.
  68
  69        STYLE provides a hint to interactive readers as to what kind of syntax
  70        is being read right now. */
  71     size_t (*read) (struct lex_reader *reader, char *buf, size_t n,
  72                     enum prompt_style style);
  73
  74     /* Closes and destroys READER, releasing any allocated storage.
  75
  76        The caller will free the 'file_name' member of READER, so the
  77        implementation should not do so. */
  78     void (*destroy) (struct lex_reader *reader);
  79   };
  80
  81 /* Helper functions for lex_reader. */
  82 void lex_reader_init (struct lex_reader *, const struct lex_reader_class *);
  83 void lex_reader_set_file_name (struct lex_reader *, const char *file_name);
  84
  85 /* Creating various kinds of lex_readers. */
  86 struct lex_reader *lex_reader_for_file (const char *file_name,
  87                                         const char *encoding,
  88                                         enum lex_syntax_mode syntax,
  89                                         enum lex_error_mode error);
  90 struct lex_reader *lex_reader_for_string (const char *, const char *encoding);
  91 struct lex_reader *lex_reader_for_format (const char *, const char *, ...)
  92   PRINTF_FORMAT (1, 3);
  93 struct lex_reader *lex_reader_for_substring_nocopy (struct substring, const char *encoding);
  94
  95 /* Initialization. */
  96 struct lexer *lex_create (void);
  97 void lex_destroy (struct lexer *);
  98
  99 /* Files. */
 100 void lex_include (struct lexer *, struct lex_reader *);
 101 void lex_append (struct lexer *, struct lex_reader *);
 102
 103 /* Advancing. */
 104 void lex_get (struct lexer *);
 105
 106 /* Token testing functions. */
 107 bool lex_is_number (const struct lexer *);
 108 double lex_number (const struct lexer *);
 109 bool lex_is_integer (const struct lexer *);
 110 long lex_integer (const struct lexer *);
 111 bool lex_is_string (const struct lexer *);
 112
 113 /* Token testing functions with lookahead. */
 114 bool lex_next_is_number (const struct lexer *, int n);
 115 double lex_next_number (const struct lexer *, int n);
 116 bool lex_next_is_integer (const struct lexer *, int n);
 117 long lex_next_integer (const struct lexer *, int n);
 118 bool lex_next_is_string (const struct lexer *, int n);
 119
 120 /* Token matching functions. */
 121 bool lex_match (struct lexer *, enum token_type);
 122 bool lex_match_id (struct lexer *, const char *);
 123 bool lex_match_id_n (struct lexer *, const char *, size_t n);
 124 bool lex_match_int (struct lexer *, int);
 125 bool lex_match_phrase (struct lexer *, const char *s);
 126
 127 /* Forcible matching functions. */
 128 bool lex_force_match (struct lexer *, enum token_type) WARN_UNUSED_RESULT;
 129 bool lex_force_match_id (struct lexer *, const char *) WARN_UNUSED_RESULT;
 130 bool lex_force_int (struct lexer *) WARN_UNUSED_RESULT;
 131 bool lex_force_num (struct lexer *) WARN_UNUSED_RESULT;
 132 bool lex_force_id (struct lexer *) WARN_UNUSED_RESULT;
 133 bool lex_force_string (struct lexer *) WARN_UNUSED_RESULT;
 134 bool lex_force_string_or_id (struct lexer *) WARN_UNUSED_RESULT;
 135
 136 /* Token accessors. */
 137 enum token_type lex_token (const struct lexer *);
 138 double lex_tokval (const struct lexer *);
 139 const char *lex_tokcstr (const struct lexer *);
 140 struct substring lex_tokss (const struct lexer *);
 141
 142 /* Looking ahead. */
 143 const struct token *lex_next (const struct lexer *, int n);
 144 enum token_type lex_next_token (const struct lexer *, int n);
 145 const char *lex_next_tokcstr (const struct lexer *, int n);
 146 double lex_next_tokval (const struct lexer *, int n);
 147 struct substring lex_next_tokss (const struct lexer *, int n);
 148
 149 /* Current position. */
 150 int lex_get_first_line_number (const struct lexer *, int n);
 151 int lex_get_last_line_number (const struct lexer *, int n);
 152 int lex_get_first_column (const struct lexer *, int n);
 153 int lex_get_last_column (const struct lexer *, int n);
 154 const char *lex_get_file_name (const struct lexer *);
 155 const char *lex_get_encoding (const struct lexer *);
 156
 157 /* Issuing errors. */
 158 void lex_error (struct lexer *, const char *, ...) PRINTF_FORMAT (2, 3);
 159 void lex_next_error (struct lexer *, int n0, int n1, const char *, ...)
 160   PRINTF_FORMAT (4, 5);
 161 int lex_end_of_command (struct lexer *);
 162
 163 void lex_error_expecting (struct lexer *, const char *, ...) SENTINEL(0);
 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 lex_syntax_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 */