summaryrefslogtreecommitdiffstatshomepage
path: root/trunk/src/lib/util/corefile.h
diff options
context:
space:
mode:
Diffstat (limited to 'trunk/src/lib/util/corefile.h')
-rw-r--r--trunk/src/lib/util/corefile.h158
1 files changed, 158 insertions, 0 deletions
diff --git a/trunk/src/lib/util/corefile.h b/trunk/src/lib/util/corefile.h
new file mode 100644
index 00000000000..8c8aeb50de6
--- /dev/null
+++ b/trunk/src/lib/util/corefile.h
@@ -0,0 +1,158 @@
+/***************************************************************************
+
+ corefile.h
+
+ Core file I/O interface functions and definitions.
+
+****************************************************************************
+
+ Copyright Aaron Giles
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are
+ met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the
+ distribution.
+ * Neither the name 'MAME' nor the names of its contributors may be
+ used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY AARON GILES ''AS IS'' AND ANY EXPRESS OR
+ IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL AARON GILES BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+
+***************************************************************************/
+
+#pragma once
+
+#ifndef __COREFILE_H__
+#define __COREFILE_H__
+
+#include <stdarg.h>
+#include "osdcore.h"
+#include "astring.h"
+
+
+
+/***************************************************************************
+ ADDITIONAL OPEN FLAGS
+***************************************************************************/
+
+#define OPEN_FLAG_NO_BOM 0x0100 /* don't output BOM */
+
+#define FCOMPRESS_NONE 0 /* no compression */
+#define FCOMPRESS_MIN 1 /* minimal compression */
+#define FCOMPRESS_MEDIUM 6 /* standard compression */
+#define FCOMPRESS_MAX 9 /* maximum compression */
+
+
+
+/***************************************************************************
+ TYPE DEFINITIONS
+***************************************************************************/
+
+typedef struct _core_file core_file;
+
+
+
+/***************************************************************************
+ FUNCTION PROTOTYPES
+***************************************************************************/
+
+
+/* ----- file open/close ----- */
+
+/* open a file with the specified filename */
+file_error core_fopen(const char *filename, UINT32 openflags, core_file **file);
+
+/* open a RAM-based "file" using the given data and length (read-only) */
+file_error core_fopen_ram(const void *data, size_t length, UINT32 openflags, core_file **file);
+
+/* open a RAM-based "file" using the given data and length (read-only), copying the data */
+file_error core_fopen_ram_copy(const void *data, size_t length, UINT32 openflags, core_file **file);
+
+/* close an open file */
+void core_fclose(core_file *file);
+
+/* enable/disable streaming file compression via zlib; level is 0 to disable compression, or up to 9 for max compression */
+file_error core_fcompress(core_file *file, int level);
+
+
+
+/* ----- file positioning ----- */
+
+/* adjust the file pointer within the file */
+int core_fseek(core_file *file, INT64 offset, int whence);
+
+/* return the current file pointer */
+UINT64 core_ftell(core_file *file);
+
+/* return true if we are at the EOF */
+int core_feof(core_file *file);
+
+/* return the total size of the file */
+UINT64 core_fsize(core_file *file);
+
+
+
+/* ----- file read ----- */
+
+/* standard binary read from a file */
+UINT32 core_fread(core_file *file, void *buffer, UINT32 length);
+
+/* read one character from the file */
+int core_fgetc(core_file *file);
+
+/* put back one character from the file */
+int core_ungetc(int c, core_file *file);
+
+/* read a full line of text from the file */
+char *core_fgets(char *s, int n, core_file *file);
+
+/* get a pointer to a buffer that holds the full file data in RAM */
+/* this function may cause the full file data to be read */
+const void *core_fbuffer(core_file *file);
+
+/* open a file with the specified filename, read it into memory, and return a pointer */
+file_error core_fload(const char *filename, void **data, UINT32 *length);
+
+
+
+/* ----- file write ----- */
+
+/* standard binary write to a file */
+UINT32 core_fwrite(core_file *file, const void *buffer, UINT32 length);
+
+/* write a line of text to the file */
+int core_fputs(core_file *f, const char *s);
+
+/* printf-style text write to a file */
+int core_vfprintf(core_file *f, const char *fmt, va_list va);
+int CLIB_DECL core_fprintf(core_file *f, const char *fmt, ...) ATTR_PRINTF(2,3);
+
+
+
+/* ----- filename utilities ----- */
+
+/* extract the base part of a filename (remove extensions and paths) */
+astring *core_filename_extract_base(astring *result, const char *name, int strip_extension);
+
+/* true if the given filename ends with a particular extension */
+int core_filename_ends_with(const char *filename, const char *extension);
+
+
+#endif /* __COREFILE_H__ */