summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/fileio.h
blob: d05905efa83227019dba0906b7ac2af72312fac1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************

    fileio.h

    Core file I/O interface functions and definitions.

***************************************************************************/

#ifndef MAME_EMU_FILEIO_H
#define MAME_EMU_FILEIO_H

#pragma once

#include "corefile.h"
#include "hash.h"

#include <iterator>
#include <string>
#include <type_traits>
#include <utility>
#include <vector>


// some systems use macros for getc/putc rather than functions
#ifdef getc
#undef getc
#endif

//**************************************************************************
//  TYPE DEFINITIONS
//**************************************************************************

// ======================> path_iterator

// helper class for iterating over configured paths
class path_iterator
{
public:
	// constructors
	path_iterator(std::string &&searchpath);
	path_iterator(std::string const &searchpath);
	path_iterator(path_iterator &&that);
	path_iterator(path_iterator const &that);

	template <typename T>
	path_iterator(T &&searchpath, std::enable_if_t<std::is_constructible<std::string, T>::value, int> = 0)
		: path_iterator(std::string(std::forward<T>(searchpath)))
	{ }

	// TODO: this doesn't work with C arrays (only vector, std::array, etc.)
	template <typename T>
	path_iterator(T &&paths, std::enable_if_t<std::is_constructible<std::string, typename std::remove_reference_t<T>::value_type>::value, int> = 0)
		: path_iterator(concatenate_paths(std::forward<T>(paths)))
	{ m_separator = '\0'; }

	// assignment operators
	path_iterator &operator=(path_iterator &&that);
	path_iterator &operator=(path_iterator const &that);

	// main interface
	bool next(std::string &buffer, const char *name = nullptr);
	void reset();

private:
	// helpers
	template <typename T>
	static std::string concatenate_paths(T &&paths)
	{
		std::string result;
		auto it(std::begin(paths));
		if (std::end(paths) != it)
		{
			result.append(*it);
			++it;
		}
		while (std::end(paths) != it)
		{
			result.append(1, '\0');
			result.append(*it);
			++it;
		}
		return result;
	}

	// internal state
	std::string                 m_searchpath;
	std::string::const_iterator m_current;
	char                        m_separator;
	bool                        m_is_first;
};



// ======================> file_enumerator

// iterate over all files in all paths specified in the searchpath
class file_enumerator
{
public:
	// construction/destruction
	template <typename... T> file_enumerator(T &&... args) : m_iterator(std::forward<T>(args)...) { }
	file_enumerator(file_enumerator &&) = default;
	file_enumerator(file_enumerator const &) = delete;
	file_enumerator &operator=(file_enumerator &&) = default;
	file_enumerator &operator=(file_enumerator const &) = delete;

	// iterator
	const osd::directory::entry *next(const char *subdir = nullptr);

private:
	// internal state
	path_iterator       m_iterator;
	osd::directory::ptr m_curdir;
	std::string         m_pathbuffer;
};



// ======================> emu_file

class emu_file
{
	enum empty_t { EMPTY };
	using searchpath_vector = std::vector<std::pair<path_iterator, std::string> >;

public:
	// file open/creation
	emu_file(u32 openflags);
	template <typename T>
	emu_file(T &&searchpath, std::enable_if_t<std::is_constructible<path_iterator, T>::value, u32> openflags)
		: emu_file(path_iterator(std::forward<T>(searchpath)), openflags)
	{ }
	template <typename T, typename U, typename V, typename... W>
	emu_file(T &&searchpath, U &&x, V &&y, W &&... z)
		: emu_file(0U, EMPTY)
	{
		m_iterator.reserve(sizeof...(W) + 1);
		m_mediapaths.reserve(sizeof...(W) + 1);
		set_searchpaths(std::forward<T>(searchpath), std::forward<U>(x), std::forward<V>(y), std::forward<W>(z)...);
	}
	virtual ~emu_file();

	// getters
	operator util::core_file &();
	bool is_open() const { return bool(m_file); }
	const char *filename() const { return m_filename.c_str(); }
	const char *fullpath() const { return m_fullpath.c_str(); }
	u32 openflags() const { return m_openflags; }
	util::hash_collection &hashes(std::string_view types);

	// setters
	void remove_on_close() { m_remove_on_close = true; }
	void set_openflags(u32 openflags) { assert(!m_file); m_openflags = openflags; }
	void set_restrict_to_mediapath(int rtmp) { m_restrict_to_mediapath = rtmp; }

	// open/close
	osd_file::error open(std::string &&name);
	osd_file::error open(std::string &&name, u32 crc);
	osd_file::error open(std::string_view name) { return open(std::string(name)); }
	osd_file::error open(std::string_view name, u32 crc) { return open(std::string(name), crc); }
	osd_file::error open(const char *name) { return open(std::string(name)); }
	osd_file::error open(const char *name, u32 crc) { return open(std::string(name), crc); }
	osd_file::error open_next();
	osd_file::error open_ram(const void *data, u32 length);
	void close();

	// control
	osd_file::error compress(int compress);

	// position
	int seek(s64 offset, int whence);
	u64 tell();
	bool eof();
	u64 size();

	// reading
	u32 read(void *buffer, u32 length);
	int getc();
	int ungetc(int c);
	char *gets(char *s, int n);

	// writing
	u32 write(const void *buffer, u32 length);
	int puts(std::string_view s);
	int vprintf(util::format_argument_pack<std::ostream> const &args);
	template <typename Format, typename... Params> int printf(Format &&fmt, Params &&...args)
	{
		return vprintf(util::make_format_argument_pack(std::forward<Format>(fmt), std::forward<Params>(args)...));
	}

	// buffers
	void flush();

private:
	emu_file(u32 openflags, empty_t);
	emu_file(path_iterator &&searchpath, u32 openflags);

	template <typename T>
	void set_searchpaths(T &&searchpath, u32 openflags)
	{
		m_iterator.emplace_back(searchpath, "");
		m_mediapaths.emplace_back(std::forward<T>(searchpath), "");
		m_openflags = openflags;
	}
	template <typename T, typename U, typename V, typename... W>
	void set_searchpaths(T &&searchpath, U &&x, V &&y, W &&... z)
	{
		m_iterator.emplace_back(searchpath, "");
		m_mediapaths.emplace_back(std::forward<T>(searchpath), "");
		set_searchpaths(std::forward<U>(x), std::forward<V>(y), std::forward<W>(z)...);
	}

	bool part_of_mediapath(const std::string &path);
	bool compressed_file_ready();

	// internal helpers
	osd_file::error attempt_zipped();
	osd_file::error load_zipped_file();

	// internal state
	std::string             m_filename;             // original filename provided
	std::string             m_fullpath;             // full filename
	util::core_file::ptr    m_file;                 // core file pointer
	searchpath_vector       m_iterator;             // iterator for paths
	searchpath_vector       m_mediapaths;           // media-path iterator
	bool                    m_first;                // true if this is the start of iteration
	u32                     m_crc;                  // file's CRC
	u32                     m_openflags;            // flags we used for the open
	util::hash_collection   m_hashes;               // collection of hashes

	std::unique_ptr<util::archive_file> m_zipfile;  // ZIP file pointer
	std::vector<u8>         m_zipdata;              // ZIP file data
	u64                     m_ziplength;            // ZIP file length

	bool                    m_remove_on_close;      // flag: remove the file when closing
	int                     m_restrict_to_mediapath; // flag: restrict to paths inside the media-path
};


extern template path_iterator::path_iterator(char *&, int);
extern template path_iterator::path_iterator(char * const &, int);
extern template path_iterator::path_iterator(char const *&, int);
extern template path_iterator::path_iterator(char const * const &, int);
extern template path_iterator::path_iterator(std::vector<std::string> &, int);
extern template path_iterator::path_iterator(const std::vector<std::string> &, int);

extern template emu_file::emu_file(std::string &, u32);
extern template emu_file::emu_file(const std::string &, u32);
extern template emu_file::emu_file(char *&, u32);
extern template emu_file::emu_file(char * const &, u32);
extern template emu_file::emu_file(char const *&, u32);
extern template emu_file::emu_file(char const * const &, u32);
extern template emu_file::emu_file(std::vector<std::string> &, u32);
extern template emu_file::emu_file(const std::vector<std::string> &, u32);

#endif // MAME_EMU_FILEIO_H