/* PSPP - a program for statistical analysis.
- Copyright (C) 1997-9, 2000, 2005, 2006, 2010, 2011 Free Software Foundation, Inc.
+ 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
#ifndef FILE_HANDLE_DEF_H
#define FILE_HANDLE_DEF_H
+#include "libpspp/compiler.h"
#include <stdbool.h>
#include <stddef.h>
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
{
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. */
/* 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_dataset (struct dataset *);
const struct fh_properties *fh_default_properties (void);
/* Reference management. */
-struct file_handle *fh_ref (struct file_handle *);
+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. */
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 *);