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 /* Record formats. */
  34 enum
  35   {
  36     FH_RF_FIXED,                /* Fixed length records. */
  37     FH_RF_VARIABLE,             /* Variable length records. */
  38     FH_RF_SPANNED               /* ? */
  39   };
  40
  41 /* File modes. */
  42 enum
  43   {
  44     FH_MD_CHARACTER,            /* Character data. */
  45     FH_MD_IMAGE,                /* ? */
  46     FH_MD_BINARY,               /* Character and/or binary data. */
  47     FH_MD_MULTIPUNCH,           /* Column binary data (not supported). */
  48     FH_MD_360                   /* ? */
  49   };
  50
  51 struct file_handle;
  52
  53 /* Services that fhusers provide to fhp. */
  54 struct fh_ext_class
  55   {
  56     int magic;                  /* Magic identifier for fhuser. */
  57     const char *name;           /* String identifier for fhuser. */
  58
  59     void (*close) (struct file_handle *);
  60                                 /* Closes any associated file, etc. */
  61   };
  62
  63 /* Opaque structure.  The `ext' member is an exception for use by
  64    subclasses.  `where.ln' is also acceptable. */
  65 struct file_handle
  66   {
  67     /* name must be the first member. */
  68     const char *name;           /* File handle identifier. */
  69     char *norm_fn;              /* Normalized filename. */
  70     char *fn;                   /* Filename as provided by user. */
  71     struct file_locator where;  /* Used for reporting error messages. */
  72
  73     int recform;                /* One of FH_RF_*. */
  74     size_t lrecl;               /* Length of records for FH_RF_FIXED. */
  75     int mode;                   /* One of FH_MD_*. */
  76
  77     struct fh_ext_class *class; /* Polymorphism support. */
  78     void *ext;                  /* Extension struct for fhuser use. */
  79   };
  80
  81 /* Pointer to the file handle that corresponds to data in the command
  82    file entered via BEGIN DATA/END DATA. */
  83 extern struct file_handle *inline_file;
  84
  85 /* Initialization. */
  86 void fh_init_files (void);
  87
  88 /* Opening and closing handles. */
  89 struct file_handle *fh_get_handle_by_name (const char name[9]);
  90 struct file_handle *fh_get_handle_by_filename (const char *filename);
  91 struct file_handle *fh_parse_file_handle (void);
  92 void fh_close_handle (struct file_handle *handle);
  93
  94 /* Handle info. */
  95 const char *fh_handle_name (const struct file_handle *handle);
  96 char *fh_handle_filename (struct file_handle *handle);
  97 size_t fh_record_width (struct file_handle *handle);
  98
  99 #endif /* !file_handle.h */