-/* PSPP - computes sample statistics.
- Copyright (C) 1997-9, 2000, 2005, 2006 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+ Copyright (C) 1997-9, 2000, 2005, 2006, 2010, 2011, 2013 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 the Free Software Foundation; either version 2 of the
- License, or (at your option) any later version.
+ 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
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- 02110-1301, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef FILE_HANDLE_DEF_H
#define FILE_HANDLE_DEF_H
+#include "libpspp/compiler.h"
#include <stdbool.h>
#include <stddef.h>
+struct dataset;
+
/* What a file handle refers to.
(Ordinarily only a single value is allowed, but fh_open()
and fh_parse() take a mask.) */
{
FH_REF_FILE = 001, /* Ordinary file (the most common case). */
FH_REF_INLINE = 002, /* The inline file. */
- FH_REF_SCRATCH = 004 /* Temporary dataset. */
+ FH_REF_DATASET = 004 /* Dataset. */
};
/* File modes. */
enum fh_mode
{
FH_MODE_TEXT, /* New-line delimited lines. */
- FH_MODE_BINARY /* Fixed-length records. */
+ FH_MODE_FIXED, /* Fixed-length records. */
+ FH_MODE_VARIABLE, /* Binary variable-length records. */
+ FH_MODE_360_VARIABLE, /* IBM 360 variable-length records. */
+ FH_MODE_360_SPANNED, /* IBM 360 variable-length, spanned records. */
+ };
+
+/* Ways to access a file. */
+enum fh_access
+ {
+ FH_ACC_READ, /* Read from it. */
+ FH_ACC_WRITE /* Write to it. */
+ };
+
+/* How a line ends.
+
+ This affects only writing FH_MODE_TEXT files. Writing in other modes does
+ not use line ends, and reading in FH_MODE_TEXT mode accepts all forms of
+ line ends. */
+enum fh_line_ends
+ {
+ FH_END_LF, /* Unix line ends (\n). */
+ FH_END_CRLF /* MS-DOS line ends (\r\n). */
};
/* Properties of a file handle. */
-struct fh_properties
+struct fh_properties
{
enum fh_mode mode; /* File mode. */
+ enum fh_line_ends line_ends; /* Line ends for text files. */
size_t record_width; /* Length of fixed-format records. */
size_t tab_width; /* Tab width, 0=do not expand tabs. */
+ const char *encoding; /* Charset for contents. */
};
void fh_init (void);
/* Creating file handles. */
struct file_handle *fh_create_file (const char *handle_name,
- const char *file_name,
+ const char *file_name, const char *file_name_encoding,
const struct fh_properties *);
-struct file_handle *fh_create_scratch (const char *handle_name);
+struct file_handle *fh_create_dataset (struct dataset *);
const struct fh_properties *fh_default_properties (void);
-/* Delete file handle from global list. */
-void fh_free (struct file_handle *);
+/* Reference management. */
+struct file_handle *fh_ref (struct file_handle *) WARN_UNUSED_RESULT;
+void fh_unref (struct file_handle *);
+void fh_unname (struct file_handle *);
/* Finding file handles. */
struct file_handle *fh_from_id (const char *handle_name);
-struct file_handle *fh_from_file_name (const char *file_name);
struct file_handle *fh_inline_file (void);
/* Generic properties of file handles. */
const char *fh_get_id (const struct file_handle *);
const char *fh_get_name (const struct file_handle *);
enum fh_referent fh_get_referent (const struct file_handle *);
+const char *fh_get_encoding (const struct file_handle *);
+
+bool fh_equal (const struct file_handle *, const struct file_handle *);
/* Properties of FH_REF_FILE file handles. */
const char *fh_get_file_name (const struct file_handle *);
+const char *fh_get_file_name_encoding (const struct file_handle *handle);
enum fh_mode fh_get_mode (const struct file_handle *) ;
+enum fh_line_ends fh_get_line_ends (const struct file_handle *);
/* Properties of FH_REF_FILE and FH_REF_INLINE file handles. */
size_t fh_get_record_width (const struct file_handle *);
size_t fh_get_tab_width (const struct file_handle *);
-/* Properties of FH_REF_SCRATCH file handles. */
-struct scratch_handle *fh_get_scratch_handle (struct file_handle *);
-void fh_set_scratch_handle (struct file_handle *, struct scratch_handle *);
+/* Properties of FH_REF_DATASET file handles. */
+struct dataset *fh_get_dataset (const struct file_handle *);
-/* Opening and closing file handles. */
-void **fh_open (struct file_handle *, enum fh_referent mask,
- const char *type, const char *mode);
-int fh_close (struct file_handle *, const char *type, const char *mode);
-bool fh_is_open (const struct file_handle *);
+/* Mutual exclusion for access . */
+struct fh_lock *fh_lock (struct file_handle *, enum fh_referent mask,
+ const char *type, enum fh_access, bool exclusive);
+bool fh_unlock (struct fh_lock *);
+void *fh_lock_get_aux (const struct fh_lock *);
+void fh_lock_set_aux (struct fh_lock *, void *aux);
+bool fh_is_locked (const struct file_handle *, enum fh_access);
/* Default file handle for DATA LIST, REREAD, REPEATING DATA
commands. */