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
|
/* $Id: io.hpp 17979 2009-11-05 22:11:04Z rubidium $ */
/*
* catcodec is a tool to decode/encode the sample catalogue for OpenTTD.
* Copyright (C) 2009 Remko Bijker
*
* 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, version 2.
*
* 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.
*/
/** @file io.hpp Interface for reading/writing to files */
#ifndef IO_H
#define IO_H
/** A string is a string; simple as that */
typedef std::string string;
/**
* Simple class to perform binary and string reading from a file.
*/
class FileReader {
FILE *file; ///< The file to be read by this instance
string filename; ///< The filename of the file
public:
/**
* Create a new reader for the given file.
* @param filename the file to read from
* @param binary read the file as binary or text?
*/
FileReader(string filename, bool binary = true);
/**
* Cleans up our mess
*/
~FileReader();
/**
* Read a single byte from the stream.
* @return the read byte
*/
uint8_t ReadByte();
/**
* Read a word (2 bytes) from the stream in little endian.
* @return the read word
*/
uint16_t ReadWord();
/**
* Read a dword (4 bytes) from the stream in little endian.
* @return the read dword
*/
uint32_t ReadDword();
/**
* Read a number of raw bytes from the stream.
* @param in the buffer where to put the data
* @param amount the amount of bytes to read
*/
void ReadRaw(uint8_t *in, size_t amount);
/**
* Read a line of text from the stream.
* @param in the buffer where to put the data
* @param length the maximum amount of bytes to read
*/
char *ReadLine(char *in, int length);
/**
* Go to a specific location in the stream.
* @param pos the position to go to.
*/
void Seek(uint32_t pos);
/**
* Get the current position in the stream.
* @return the position in the stream
*/
uint32_t GetPos();
/**
* Get the filename of this file.
* @return the filename
*/
string GetFilename() const;
};
/**
* Simple class to perform binary and string writing to a file.
*/
class FileWriter {
FILE *file; ///< The file to be read by this instance
string filename; ///< The filename of the file
string filename_new; ///< The filename for the temporary file
public:
/**
* Create a new writer for the given file.
* @param filename the file to write to
* @param binary write the file as binary or text?
*/
FileWriter(string filename, bool binary = true);
/**
* Cleans up our mess
*/
~FileWriter();
/**
* Write a single byte to the stream.
* @param data the byte to write
*/
void WriteByte(uint8_t data);
/**
* Write a word (2 bytes) to the stream in little endian.
* @param data the word to write
*/
void WriteWord(uint16_t data);
/**
* Write a dword (4 bytes) to the stream in little endian.
* @param data the dword to write
*/
void WriteDword(uint32_t data);
/**
* Write a number of raw bytes to the stream.
* @param out the buffer of data to write
* @param amount the amount of bytes to write
*/
void WriteRaw(const uint8_t *out, size_t amount);
/**
* Write a line of text to the stream.
* @param format the format of the written string
* @param ... the data to actually write
*/
void WriteString(const char *format, ...);
/**
* Get the current position in the stream.
* @return the position in the stream
*/
uint32_t GetPos();
/**
* Get the filename of this file.
* @return the filename
*/
string GetFilename() const;
/**
* Close the output, i.e. commit the file to disk.
* If this is not done, the file with not be written to disk.
*/
void Close();
};
#endif /* IO_H */
|
