sys-file-reader: Break reading a system file into two stages.

[pspp] / src / data / sys-file-reader.h

diff --git a/src/data/sys-file-reader.h b/src/data/sys-file-reader.h
index 037d33a394ce2a8397337aa87373672ba2d31223..254e810a6c83d6f60de25e7f1203f720e9aa910d 100644 (file)
--- a/src/data/sys-file-reader.h
+++ b/src/data/sys-file-reader.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2009, 2011, 2012, 2013 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2009, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -21,11 +21,43 @@
 #include <stdio.h>
 
 #include "data/case.h"
+#include "data/sys-file.h"
 #include "libpspp/float-format.h"
 #include "libpspp/integer-format.h"
 
-/* Reading system files. */
+/* Reading system files.
 
+   To read a system file:
+
+      1. Open it with sfm_open().
+
+      2. Figure out what encoding to read it with.  sfm_get_encoding() can
+         help.
+
+      3. Obtain a casereader with sfm_decode().
+
+   If, after step 1 or 2, you decide that you don't want the system file
+   anymore, you can close it with sfm_close().  Otherwise, don't call
+   sfm_close(), because sfm_decode() consumes it. */
+
+struct dictionary;
+struct file_handle;
+struct sfm_read_info;
+
+/* Opening and closing an sfm_reader. */
+struct sfm_reader *sfm_open (struct file_handle *);
+bool sfm_close (struct sfm_reader *);
+
+/* Obtaining information about an sfm_reader before . */
+const char *sfm_get_encoding (const struct sfm_reader *);
+
+/* Decoding a system file's dictionary and obtaining a casereader. */
+struct casereader *sfm_decode (struct sfm_reader *, const char *encoding,
+                               struct dictionary **, struct sfm_read_info *);
+
+/* Detecting whether a file is a system file. */
+bool sfm_detect (FILE *);
+\f
 /* System file info that doesn't fit in struct dictionary.
 
    The strings in this structure are encoded in UTF-8.  (They are normally in
@@ -36,7 +68,7 @@ struct sfm_read_info
     char *creation_time;       /* "hh:mm:ss". */
     enum integer_format integer_format;
     enum float_format float_format;
-    bool compressed;           /* 0=no, 1=yes. */
+    enum sfm_compression compression;
     casenumber case_cnt;        /* -1 if unknown. */
     char *product;             /* Product name. */
     char *product_ext;          /* Extra product info. */
@@ -51,11 +83,4 @@ struct sfm_read_info
 
 void sfm_read_info_destroy (struct sfm_read_info *);
 
-struct dictionary;
-struct file_handle;
-struct casereader *sfm_open_reader (struct file_handle *, const char *encoding,
-                                    struct dictionary **,
-                                    struct sfm_read_info *);
-bool sfm_detect (FILE *);
-
 #endif /* sys-file-reader.h */