src/helper/fileio.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  25  ***************************************************************************/
  26
  27 #ifndef FILEIO_H
  28 #define FILEIO_H
  29
  30 #define FILEIO_MAX_ERROR_STRING         (128)
  31
  32 enum fileio_type {
  33         FILEIO_TEXT,
  34         FILEIO_BINARY,
  35 };
  36
  37 enum fileio_access {
  38         FILEIO_NONE,            /* open without any access (invalid mode) */
  39         FILEIO_READ,            /* open for reading, position at beginning */
  40         FILEIO_WRITE,           /* open for writing, position at beginning */
  41         FILEIO_READWRITE,       /* open for writing, position at beginning, allow reading */
  42         FILEIO_APPEND,          /* open for writing, position at end */
  43         FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
  44 };
  45
  46 struct fileio {
  47         /* The structure is opaque */
  48         struct fileio_internal *fp;
  49 };
  50
  51 int fileio_open(struct fileio *fileio,
  52                 const char *url, enum fileio_access access_type, enum fileio_type type);
  53 int fileio_close(struct fileio *fileio);
  54
  55 int fileio_seek(struct fileio *fileio, size_t position);
  56 int fileio_fgets(struct fileio *fileio, size_t size, void *buffer);
  57
  58 int fileio_read(struct fileio *fileio,
  59                 size_t size, void *buffer, size_t *size_read);
  60 int fileio_write(struct fileio *fileio,
  61                 size_t size, const void *buffer, size_t *size_written);
  62
  63 int fileio_read_u32(struct fileio *fileio, uint32_t *data);
  64 int fileio_write_u32(struct fileio *fileio, uint32_t data);
  65 int fileio_size(struct fileio *fileio, int *size);
  66
  67 #define ERROR_FILEIO_LOCATION_UNKNOWN                   (-1200)
  68 #define ERROR_FILEIO_NOT_FOUND                                  (-1201)
  69 #define ERROR_FILEIO_OPERATION_FAILED                   (-1202)
  70 #define ERROR_FILEIO_ACCESS_NOT_SUPPORTED               (-1203)
  71 #define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN              (-1204)
  72 #define ERROR_FILEIO_OPERATION_NOT_SUPPORTED    (-1205)
  73
  74 #endif  /* FILEIO_H */