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, see <http://www.gnu.org/licenses/>. *
  23  ***************************************************************************/
  24
  25 #ifndef OPENOCD_HELPER_FILEIO_H
  26 #define OPENOCD_HELPER_FILEIO_H
  27
  28 #define FILEIO_MAX_ERROR_STRING         (128)
  29
  30 enum fileio_type {
  31         FILEIO_TEXT,
  32         FILEIO_BINARY,
  33 };
  34
  35 enum fileio_access {
  36         FILEIO_NONE,            /* open without any access (invalid mode) */
  37         FILEIO_READ,            /* open for reading, position at beginning */
  38         FILEIO_WRITE,           /* open for writing, position at beginning */
  39         FILEIO_READWRITE,       /* open for writing, position at beginning, allow reading */
  40         FILEIO_APPEND,          /* open for writing, position at end */
  41         FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
  42 };
  43
  44 struct fileio;
  45
  46 int fileio_open(struct fileio **fileio, const char *url,
  47                 enum fileio_access access_type, enum fileio_type type);
  48 int fileio_close(struct fileio *fileio);
  49 int fileio_feof(struct fileio *fileio);
  50
  51 int fileio_seek(struct fileio *fileio, size_t position);
  52 int fileio_fgets(struct fileio *fileio, size_t size, void *buffer);
  53
  54 int fileio_read(struct fileio *fileio,
  55                 size_t size, void *buffer, size_t *size_read);
  56 int fileio_write(struct fileio *fileio,
  57                 size_t size, const void *buffer, size_t *size_written);
  58
  59 int fileio_read_u32(struct fileio *fileio, uint32_t *data);
  60 int fileio_write_u32(struct fileio *fileio, uint32_t data);
  61 int fileio_size(struct fileio *fileio, size_t *size);
  62
  63 #define ERROR_FILEIO_LOCATION_UNKNOWN                   (-1200)
  64 #define ERROR_FILEIO_NOT_FOUND                                  (-1201)
  65 #define ERROR_FILEIO_OPERATION_FAILED                   (-1202)
  66 #define ERROR_FILEIO_ACCESS_NOT_SUPPORTED               (-1203)
  67 #define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN              (-1204)
  68 #define ERROR_FILEIO_OPERATION_NOT_SUPPORTED    (-1205)
  69
  70 #endif /* OPENOCD_HELPER_FILEIO_H */