gfsmIO.h

Go to the documentation of this file.

/*=============================================================================*\
 * File: gfsmIO.h
 * Author: Bryan Jurish <moocow.bovine@gmail.com>
 * Description: finite state machine library: I/O
 *
 * Copyright (c) 2006-2008 Bryan Jurish.
 *
 * For information on usage and redistribution, and for a DISCLAIMER
 * OF ALL WARRANTIES, see the file "COPYING" in this distribution.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *=============================================================================*/

#ifndef _GFSM_IO_H
#define _GFSM_IO_H

#include <gfsmConfig.h>
#include <gfsmError.h>

#include <stdarg.h>
#include <string.h>
#include <unistd.h>
#include <stdio.h>

#define GFSMIO_EOF ((int)-1)

/*======================================================================
 * I/O: types
 */

typedef enum {
  gfsmIOTCFile,         
  gfsmIOTZFile,         
  gfsmIOTGString,       
  gfsmIOTUser = 255     
} gfsmIOHandleType;

/*======================================================================
 * I/O: Handles: Function types
 */

typedef void (*gfsmIOFlushFunc) (void *handle);

typedef void (*gfsmIOCloseFunc) (void *handle);

typedef gboolean (*gfsmIOEofFunc) (void *handle);


typedef gboolean (*gfsmIOReadFunc)  (void *handle, void *buf, size_t nbytes);

typedef ssize_t (*gfsmIOGetdelimFunc)  (void *handle, char **lineptr, size_t *n, int delim);


typedef gboolean (*gfsmIOWriteFunc) (void *handle, const void *buf, size_t nbytes);

typedef int (*gfsmIOVprintfFunc) (void *handle, const char *fmt, va_list *app);



/*======================================================================
 * I/O: Handles: structs
 */

typedef struct {
  gfsmIOHandleType    iotype;  
  void               *handle;  

  gfsmIOReadFunc     read_func;       
  gfsmIOGetdelimFunc getdelim_func;   
  gfsmIOWriteFunc    write_func;     
  gfsmIOVprintfFunc  vprintf_func;   
  gfsmIOFlushFunc    flush_func;     
  gfsmIOCloseFunc    close_func;     
  gfsmIOEofFunc      eof_func;       
} gfsmIOHandle;


typedef struct {
  GString *gs;  
  size_t   pos; 
} gfsmPosGString;

/*======================================================================
 * I/O: Handles: Constructors etc.
 */

gfsmIOHandle *gfsmio_handle_new(gfsmIOHandleType typ, void *handle_data);

void gfsmio_handle_free(gfsmIOHandle *ioh);

/* TODO: utilities ? file_handle_new, zfile_handle_new, gstring_handle_new, user_handle_new ? */

gfsmIOHandle *gfsmio_new_file(FILE *f);

gfsmIOHandle *gfsmio_new_zfile(FILE *f, const char *mode, int compress_level);

gfsmIOHandle *gfsmio_new_filename(const char *filename, const char *mode, int compress_level, gfsmError **errp);

gfsmIOHandle *gfsmio_new_gstring(gfsmPosGString *pgs);

/*======================================================================
 * I/O: Handles: Methods: Basic
 */

void gfsmio_close(gfsmIOHandle *ioh);

void gfsmio_flush(gfsmIOHandle *ioh);

gboolean gfsmio_eof(gfsmIOHandle *ioh);



/*======================================================================
 * I/O: Handles: Methods: Read
 */

int gfsmio_getc(gfsmIOHandle *ioh);

gboolean gfsmio_read(gfsmIOHandle *ioh, void *buf, size_t nbytes);

ssize_t gfsmio_getline(gfsmIOHandle *ioh, char **lineptr, size_t *n);


ssize_t gfsmio_getdelim(gfsmIOHandle *io, char **lineptr, size_t *n, int delim);



/*======================================================================
 * I/O: Handles: Methods: Write
 */

gboolean gfsmio_putc(gfsmIOHandle *ioh, int c);

gboolean gfsmio_puts(gfsmIOHandle *io, const char *s);

gboolean gfsmio_write(gfsmIOHandle *io, const void *buf, size_t nbytes);

int gfsmio_printf(gfsmIOHandle *io, const char *fmt, ...);

int gfsmio_vprintf(gfsmIOHandle *io, const char *fmt, va_list *app);


#endif /* _GFSM_IO_H */