X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fdata%2Fsys-file-reader.h;h=849da670fce2f1f0ebe21b830dd41386eee536e0;hb=563b6160d2ed20120fbb62410a65e03c28537383;hp=4fc14456fed62b9b98769c1f29f8019f8601d637;hpb=8d6ff8a6bd25b184474a117c8332275b5add2d2b;p=pspp

diff --git a/src/data/sys-file-reader.h b/src/data/sys-file-reader.h
index 4fc14456fe..849da670fc 100644
--- a/src/data/sys-file-reader.h
+++ b/src/data/sys-file-reader.h
@@ -25,8 +25,41 @@
 #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 *);
+size_t sfm_get_strings (const struct sfm_reader *, struct pool *pool,
+                        char ***labels, bool **ids, char ***values);
+
+/* 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 *);
+
 /* System file info that doesn't fit in struct dictionary.
 
    The strings in this structure are encoded in UTF-8.  (They are normally in
@@ -52,11 +85,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 */