fileio: improve API types

[openocd.git] / src / helper / fileio.h

diff --git a/src/helper/fileio.h b/src/helper/fileio.h
index 471c5da1412f0928e0993c0dbeb5936490581d4c..325b441ff9884191b438db8ac9be1697214f2d9f 100644 (file)
--- a/src/helper/fileio.h
+++ b/src/helper/fileio.h
@@ -2,9 +2,12 @@
  *   Copyright (C) 2007 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                      *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -23,17 +26,9 @@
 #ifndef FILEIO_H
 #define FILEIO_H
 
-#define FILEIO_MAX_ERROR_STRING                (128)
-
 #include "types.h"
 
-#include <stdio.h>
-#include <unistd.h>
-#include <stdlib.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <errno.h>
-#include <ctype.h>
+#define FILEIO_MAX_ERROR_STRING                (128)
 
 enum fileio_type
 {
@@ -41,9 +36,9 @@ enum fileio_type
        FILEIO_BINARY,
 };
 
-
 enum fileio_access
 {
+       FILEIO_NONE,            /* open without any access (invalid mode) */
        FILEIO_READ,            /* open for reading, position at beginning */
        FILEIO_WRITE,           /* open for writing, position at beginning */
        FILEIO_READWRITE,       /* open for writing, position at beginning, allow reading */
@@ -51,24 +46,29 @@ enum fileio_access
        FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
 };
 
-typedef struct fileio_s
-{
-       char *url;
-       long long size;
+struct fileio {
+       const char *url;
+       ssize_t size;
        enum fileio_type type;
        enum fileio_access access;
        FILE *file;
-} fileio_t;
+};
+
+int fileio_open(struct fileio *fileio,
+       const char *url, enum fileio_access access, enum fileio_type type);
+int fileio_close(struct fileio *fileio);
+
+int fileio_seek(struct fileio *fileio, size_t position);
+int fileio_fgets(struct fileio *fileio, size_t size, void *buffer);
+
+int fileio_read(struct fileio *fileio,
+               size_t size, void *buffer, size_t *size_read);
+int fileio_write(struct fileio *fileio,
+               size_t size, const void *buffer, size_t *size_written);
+
+int fileio_read_u32(struct fileio *fileio, uint32_t *data);
+int fileio_write_u32(struct fileio *fileio, uint32_t data);
 
-extern int fileio_write(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_written);
-extern int fileio_read(fileio_t *fileio, u32 size, u8 *buffer, u32 *size_read);
-extern int fileio_fgets(fileio_t *fileio, u32 size, char *buffer);
-extern int fileio_seek(fileio_t *fileio, u32 position);
-extern int fileio_close(fileio_t *fileio);
-extern int fileio_open(fileio_t *fileio, char *url, enum fileio_access access, enum fileio_type type);
-extern int fileio_read_u32(fileio_t *fileio, u32 *data);
-extern int fileio_write_u32(fileio_t *fileio, u32 data);
-       
 #define ERROR_FILEIO_LOCATION_UNKNOWN  (-1200)
 #define ERROR_FILEIO_NOT_FOUND                 (-1201)
 #define ERROR_FILEIO_OPERATION_FAILED          (-1202)