src/language/data-io/data-reader.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 #ifndef DFM_READ_H
  20 #define DFM_READ_H
  21
  22 /* Data file manager (dfm).
  23
  24    This module is in charge of reading and writing data files (other
  25    than system files).  dfm is an fhuser, so see file-handle.h for the
  26    fhuser interface. */
  27
  28 #include <stdbool.h>
  29 #include <stddef.h>
  30
  31 struct file_handle;
  32 struct string;
  33 struct lexer;
  34
  35 /* Input. */
  36 struct dfm_reader *dfm_open_reader (struct file_handle *, struct lexer *);
  37 void dfm_close_reader (struct dfm_reader *);
  38 bool dfm_reader_error (const struct dfm_reader *);
  39 unsigned dfm_eof (struct dfm_reader *);
  40 struct substring dfm_get_record (struct dfm_reader *);
  41 void dfm_expand_tabs (struct dfm_reader *);
  42
  43 /* Line control. */
  44 void dfm_forward_record (struct dfm_reader *);
  45 void dfm_reread_record (struct dfm_reader *, size_t column);
  46 void dfm_forward_columns (struct dfm_reader *, size_t columns);
  47 size_t dfm_column_start (const struct dfm_reader *);
  48 size_t dfm_columns_past_end (const struct dfm_reader *);
  49 size_t dfm_get_column (const struct dfm_reader *, const char *);
  50
  51 /* File stack. */
  52 void dfm_push (struct dfm_reader *);
  53 void dfm_pop (struct dfm_reader *);
  54
  55 #endif /* data-reader.h */