src/file-handle.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., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #if !file_handle_h
  21 #define file_handle_h 1
  22
  23 /* File handle provider (fhp).
  24
  25    This module provides file handles in the form of file_handle
  26    structures to the dfm and sfm modules, which are known as file
  27    handle users (fhusers).  fhp does not know anything about file
  28    contents. */
  29
  30 #include <stddef.h>
  31 #include "error.h"
  32
  33 struct file_handle;
  34
  35 /* Services that fhusers provide to fhp. */
  36 struct fh_ext_class
  37   {
  38     int magic;                  /* Magic identifier for fhuser. */
  39     const char *name;           /* String identifier for fhuser. */
  40
  41     void (*close) (struct file_handle *); /* Closes the file. */
  42   };
  43
  44 /* Mostly-opaque structure. */
  45 struct file_handle
  46   {
  47     struct private_file_handle *private;
  48     const struct fh_ext_class *class;   /* Polymorphism support. */
  49     void *ext;                  /* Extension struct for fhuser use. */
  50   };
  51
  52 /* File modes. */
  53 enum file_handle_mode
  54   {
  55     MODE_TEXT,                  /* New-line delimited lines. */
  56     MODE_BINARY                 /* Fixed-length records. */
  57   };
  58
  59 /* Pointer to the file handle that corresponds to data in the command
  60    file entered via BEGIN DATA/END DATA. */
  61 extern struct file_handle *inline_file;
  62
  63 /* Initialization. */
  64 void fh_init_files (void);
  65
  66 /* Opening and closing handles. */
  67 struct file_handle *fh_parse_file_handle (void);
  68 void fh_close_handle (struct file_handle *handle);
  69
  70 /* Handle info. */
  71 const char *handle_get_name (const struct file_handle *handle);
  72 const char *handle_get_filename (const struct file_handle *handle);
  73 enum file_handle_mode handle_get_mode (const struct file_handle *);
  74 size_t handle_get_record_width (const struct file_handle *);
  75 size_t handle_get_tab_width (const struct file_handle *);
  76
  77 #endif /* !file_handle.h */