checkpatch: add logging functions
[fw/openocd] / src / helper / fileio.h
index c3824ff8fe9bd358598b730b4717fda01a1b83de..6b4be8ef560efe8b170a8f6abb544ea7bcb3efdd 100644 (file)
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2007 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,25 +9,12 @@
  *                                                                         *
  *   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     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
-#ifndef FILEIO_H
-#define FILEIO_H
+#ifndef OPENOCD_HELPER_FILEIO_H
+#define OPENOCD_HELPER_FILEIO_H
+
+#include "types.h"
 
 #define FILEIO_MAX_ERROR_STRING                (128)
 
@@ -43,14 +32,12 @@ enum fileio_access {
        FILEIO_APPENDREAD,      /* open for writing, position at end, allow reading */
 };
 
-struct fileio {
-       /* The structure is opaque */
-       struct fileio_internal *fp;
-};
+struct fileio;
 
-int fileio_open(struct fileio *fileio,
-               const char *url, enum fileio_access access_type, enum fileio_type type);
+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);
@@ -71,4 +58,4 @@ int fileio_size(struct fileio *fileio, size_t *size);
 #define ERROR_FILEIO_RESOURCE_TYPE_UNKNOWN             (-1204)
 #define ERROR_FILEIO_OPERATION_NOT_SUPPORTED   (-1205)
 
-#endif /* FILEIO_H */
+#endif /* OPENOCD_HELPER_FILEIO_H */