src/language/data-io/data-reader.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20 #ifndef DFM_READ_H
  21 #define DFM_READ_H
  22
  23 /* Data file manager (dfm).
  24
  25    This module is in charge of reading and writing data files (other
  26    than system files).  dfm is an fhuser, so see file-handle.h for the
  27    fhuser interface. */
  28
  29 #include <stdbool.h>
  30 #include <stddef.h>
  31
  32 struct file_handle;
  33 struct string;
  34 struct lexer;
  35
  36 /* Input. */
  37 struct dfm_reader *dfm_open_reader (struct file_handle *, struct lexer *);
  38 void dfm_close_reader (struct dfm_reader *);
  39 bool dfm_reader_error (const struct dfm_reader *);
  40 unsigned dfm_eof (struct dfm_reader *);
  41 struct substring dfm_get_record (struct dfm_reader *);
  42 void dfm_expand_tabs (struct dfm_reader *);
  43
  44 /* Line control. */
  45 void dfm_forward_record (struct dfm_reader *);
  46 void dfm_reread_record (struct dfm_reader *, size_t column);
  47 void dfm_forward_columns (struct dfm_reader *, size_t columns);
  48 size_t dfm_column_start (const struct dfm_reader *);
  49 size_t dfm_columns_past_end (const struct dfm_reader *);
  50 size_t dfm_get_column (const struct dfm_reader *, const char *);
  51
  52 /* File stack. */
  53 void dfm_push (struct dfm_reader *);
  54 void dfm_pop (struct dfm_reader *);
  55
  56 #endif /* data-reader.h */