Handle improperly build image files gracefully

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

diff --git a/src/helper/fileio.h b/src/helper/fileio.h
index c764082e9e37e1ebe349a94c10596685784f8d21..02592e28d0ed9e4df168d706dad1861b14a44d01 100644 (file)
--- a/src/helper/fileio.h
+++ b/src/helper/fileio.h
@@ -2,7 +2,7 @@
  *   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                                  *
@@ -19,32 +19,21 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
-#ifndef FILEIO_H
-#define FILEIO_H
 
-#define FILEIO_MAX_ERROR_STRING                (128)
-
-#include "types.h"
+#ifndef OPENOCD_HELPER_FILEIO_H
+#define OPENOCD_HELPER_FILEIO_H
 
-#include <stdio.h>
-#include <unistd.h>
-#include <stdlib.h>
-#include <sys/stat.h>
-#include <errno.h>
-#include <ctype.h>
+#define FILEIO_MAX_ERROR_STRING                (128)
 
-enum fileio_type
-{
+enum fileio_type {
        FILEIO_TEXT,
        FILEIO_BINARY,
 };
 
-enum fileio_access
-{
+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 */
@@ -52,29 +41,30 @@ enum fileio_access
        FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
 };
 
-typedef struct fileio_s
-{
-       char *url;
-       long long size;
-       enum fileio_type type;
-       enum fileio_access access;
-       FILE *file;
-} fileio_t;
+struct fileio;
+
+int fileio_open(struct fileio **fileio, const char *url,
+               enum fileio_access access_type, enum fileio_type type);
+int fileio_close(struct fileio *fileio);
+int fileio_feof(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);
 
-extern int fileio_write(fileio_t *fileio, u32 size, const 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, const 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);
+int fileio_read_u32(struct fileio *fileio, uint32_t *data);
+int fileio_write_u32(struct fileio *fileio, uint32_t data);
+int fileio_size(struct fileio *fileio, size_t *size);
 
-#define ERROR_FILEIO_LOCATION_UNKNOWN  (-1200)
-#define ERROR_FILEIO_NOT_FOUND                 (-1201)
-#define ERROR_FILEIO_OPERATION_FAILED          (-1202)
-#define ERROR_FILEIO_ACCESS_NOT_SUPPORTED      (-1203)
-#define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN     (-1204)
+#define ERROR_FILEIO_LOCATION_UNKNOWN                  (-1200)
+#define ERROR_FILEIO_NOT_FOUND                                 (-1201)
+#define ERROR_FILEIO_OPERATION_FAILED                  (-1202)
+#define ERROR_FILEIO_ACCESS_NOT_SUPPORTED              (-1203)
+#define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN             (-1204)
 #define ERROR_FILEIO_OPERATION_NOT_SUPPORTED   (-1205)
 
-#endif /* FILEIO_H */
+#endif /* OPENOCD_HELPER_FILEIO_H */