X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Ffile-handle-def.h;h=c5c61ea865a34cc67e8ea56aa473872d31f3fac0;hb=000e3e8c5818476c3afbc75fad9347aefb6e902a;hp=930477a9170d8b857d49fa50d26008cefd6fa7cb;hpb=72fa0b1128357f3c0b471fddc5d0ff77766a2ea7;p=pspp diff --git a/src/file-handle-def.h b/src/file-handle-def.h index 930477a917..c5c61ea865 100644 --- a/src/file-handle-def.h +++ b/src/file-handle-def.h @@ -1,5 +1,5 @@ /* PSPP - computes sample statistics. - Copyright (C) 1997-9, 2000,2005 Free Software Foundation, Inc. + Copyright (C) 1997-9, 2000, 2005, 2006 Free Software Foundation, Inc. Written by Ben Pfaff . This program is free software; you can redistribute it and/or @@ -20,78 +20,77 @@ #ifndef FILE_HANDLE_DEF_H #define FILE_HANDLE_DEF_H -#include +#include +#include -/* File modes. */ -enum file_handle_mode +/* What a file handle refers to. + (Ordinarily only a single value is allowed, but fh_open() + and fh_parse() take a mask.) */ +enum fh_referent { - MODE_TEXT, /* New-line delimited lines. */ - MODE_BINARY /* Fixed-length records. */ + FH_REF_FILE = 001, /* Ordinary file (the most common case). */ + FH_REF_INLINE = 002, /* The inline file. */ + FH_REF_SCRATCH = 004 /* Temporary dataset. */ }; -struct file_handle *create_file_handle_with_defaults (const char *handle_name, - const char *filename); - -struct file_handle *create_file_handle (const char *handle_name, - const char *filename, - enum file_handle_mode mode, - size_t length, - size_t tab_width - ); - - - -struct file_handle * -get_handle_with_name (const char *handle_name) ; - -struct file_handle * -get_handle_for_filename (const char *filename); - -const char *handle_get_name (const struct file_handle *handle); - -/* Returns the name of the file associated with HANDLE. */ -const char *handle_get_filename (const struct file_handle *handle) ; - - - -/* Returns the mode of HANDLE. */ -enum file_handle_mode handle_get_mode (const struct file_handle *handle) ; - -/* Returns the width of a logical record on HANDLE. */ -size_t handle_get_record_width (const struct file_handle *handle); - - -/* Returns the number of characters per tab stop for HANDLE, or - zero if tabs are not to be expanded. Applicable only to - MODE_TEXT files. */ -size_t handle_get_tab_width (const struct file_handle *handle); - - - -void destroy_file_handle(void *fh_, void *aux UNUSED); - - -/* Tries to open handle H with the given TYPE and MODE. - - TYPE is the sort of file, e.g. "system file". Only one given - type of access is allowed on a given file handle at once. - - MODE combines the read or write mode with the sharing mode. - The first character is 'r' for read, 'w' for write. The - second character is 's' to permit sharing, 'e' to require - exclusive access. - - Returns the address of a void * that the caller can use for - data specific to the file handle if successful, or a null - pointer on failure. For exclusive access modes the void * - will always be a null pointer at return. In shared access - modes the void * will necessarily be null only if no other - sharers are active. - - If successful, a reference to type is retained, so it should - probably be a string literal. */ +/* File modes. */ +enum fh_mode + { + FH_MODE_TEXT, /* New-line delimited lines. */ + FH_MODE_BINARY /* Fixed-length records. */ + }; -void ** fh_open (struct file_handle *h, const char *type, const char *mode) ; +/* Properties of a file handle. */ +struct fh_properties + { + enum fh_mode mode; /* File mode. */ + size_t record_width; /* Length of fixed-format records. */ + size_t tab_width; /* Tab width, 0=do not expand tabs. */ + }; +void fh_init (void); +void fh_done (void); + +/* Creating file handles. */ +struct file_handle *fh_create_file (const char *handle_name, + const char *filename, + const struct fh_properties *); +struct file_handle *fh_create_scratch (const char *handle_name); +const struct fh_properties *fh_default_properties (void); + +/* Delete file handle from global list. */ +void fh_free (struct file_handle *); + +/* Finding file handles. */ +struct file_handle *fh_from_name (const char *handle_name); +struct file_handle *fh_from_filename (const char *filename); +struct file_handle *fh_inline_file (void); + +/* Generic properties of file handles. */ +const char *fh_get_name (const struct file_handle *); +enum fh_referent fh_get_referent (const struct file_handle *); + +/* Properties of FH_REF_FILE file handles. */ +const char *fh_get_filename (const struct file_handle *); +enum fh_mode fh_get_mode (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 *); + +/* 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 *); + +/* Default file handle for DATA LIST, REREAD, REPEATING DATA + commands. */ +struct file_handle *fh_get_default_handle (void); +void fh_set_default_handle (struct file_handle *); #endif