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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26 #ifndef FILEIO_H
  27 #define FILEIO_H
  28
  29 #include <helper/types.h>
  30
  31 #define FILEIO_MAX_ERROR_STRING         (128)
  32
  33 enum fileio_type
  34 {
  35         FILEIO_TEXT,
  36         FILEIO_BINARY,
  37 };
  38
  39 enum fileio_access
  40 {
  41         FILEIO_NONE,            /* open without any access (invalid mode) */
  42         FILEIO_READ,            /* open for reading, position at beginning */
  43         FILEIO_WRITE,           /* open for writing, position at beginning */
  44         FILEIO_READWRITE,       /* open for writing, position at beginning, allow reading */
  45         FILEIO_APPEND,          /* open for writing, position at end */
  46         FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
  47 };
  48
  49 struct fileio
  50 {
  51         /* The structure is opaque */
  52         struct fileio_internal *fp;
  53 };
  54
  55 int fileio_open(struct fileio *fileio,
  56         const char *url, enum fileio_access access, enum fileio_type type);
  57 int fileio_close(struct fileio *fileio);
  58
  59 int fileio_seek(struct fileio *fileio, size_t position);
  60 int fileio_fgets(struct fileio *fileio, size_t size, void *buffer);
  61
  62 int fileio_read(struct fileio *fileio,
  63                 size_t size, void *buffer, size_t *size_read);
  64 int fileio_write(struct fileio *fileio,
  65                 size_t size, const void *buffer, size_t *size_written);
  66
  67 int fileio_read_u32(struct fileio *fileio, uint32_t *data);
  68 int fileio_write_u32(struct fileio *fileio, uint32_t data);
  69 int fileio_size(struct fileio *fileio);
  70
  71 #define ERROR_FILEIO_LOCATION_UNKNOWN   (-1200)
  72 #define ERROR_FILEIO_NOT_FOUND                  (-1201)
  73 #define ERROR_FILEIO_OPERATION_FAILED           (-1202)
  74 #define ERROR_FILEIO_ACCESS_NOT_SUPPORTED       (-1203)
  75 #define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN      (-1204)
  76 #define ERROR_FILEIO_OPERATION_NOT_SUPPORTED    (-1205)
  77
  78 #endif /* FILEIO_H */