aboutsummaryrefslogtreecommitdiffstats
path: root/src/kvilib/file/KviFile.h
blob: 40004eb206fbf34d45b3ee521d1e6f3f371815c4 (about) (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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
#ifndef _KVI_FILE_H_
#define _KVI_FILE_H_
//=============================================================================
//
//   File : KviFile.h
//   Creation date : Mon Dec 17 2001 00:05:04 by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2001-2010 Szymon Stefanek (pragma at kvirc dot net)
//
//   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.
//
//=============================================================================

/**
* \file KviFile.h
* \author Szymon Stefanek
* \brief This file handles file operations performed by KVIrc
*/

#include "kvi_settings.h"
#include "KviHeapObject.h"
#include "KviPointerList.h"
#include "kvi_inttypes.h"

#include <QFile>

class KviCString;
class QByteArray;

#define kvi_file_offset_t qlonglong

/**
* \class KviFile
* \brief KVIrc File class
*/
class KVILIB_API KviFile : public QFile, public KviHeapObject
{
public:
	/**
	* \brief Constructs file object
	* \return KviFile
	*/
	KviFile();

	/**
	* \brief Constructs file object
	* \param szName The name of the file
	* \return KviFile
	*/
	KviFile(const QString & szName);

	/**
	* \brief Destroys file object
	*/
	~KviFile();

public:
	/**
	* \brief Saves a file
	* \param file The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(kvi_u64_t file);

	/**
	* \brief Saves a file
	* \param file The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(kvi_i64_t file) { return save((kvi_u64_t)file); };

	/**
	* \brief Saves a file
	* \param file The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(kvi_u32_t file);

	/**
	* \brief Saves a file
	* \param file The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(kvi_i32_t file) { return save((kvi_u32_t)file); };

	/**
	* \brief Saves a file
	* \param file The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(kvi_u16_t file);

	/**
	* \brief Saves a file
	* \param file The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(kvi_i16_t file) { return save((kvi_u16_t)file); };

	/**
	* \brief Saves a file
	* \param file The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(kvi_u8_t file);

	/**
	* \brief Saves a file
	* \param file The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(kvi_i8_t file) { return save((kvi_u8_t)file); };

	/**
	* \brief Saves a file
	* \param szData The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(const KviCString & szData);

	/**
	* \brief Saves a file
	* \param data The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(const QByteArray & data);

	/**
	* \brief Saves a file
	* \param szData The file to save
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(const QString & szData);

	/**
	* \brief Saves a file to a list
	* \param pData The list where file to save is
	* \warning This function saves LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool save(KviPointerList<KviCString> * pData);

	/**
	* \brief Loads a file
	* \param file The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(kvi_u64_t & file);

	/**
	* \brief Loads a file
	* \param file The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(kvi_i64_t & file) { return load((kvi_u64_t &)file); };

	/**
	* \brief Loads a file
	* \param file The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(kvi_u32_t & file);

	/**
	* \brief Loads a file
	* \param file The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(kvi_i32_t & file) { return load((kvi_u32_t &)file); };

	/**
	* \brief Loads a file
	* \param file The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(kvi_u16_t & file);

	/**
	* \brief Loads a file
	* \param file The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(kvi_i16_t & file) { return load((kvi_u16_t &)file); };

	/**
	* \brief Loads a file
	* \param file The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(kvi_u8_t & file);

	/**
	* \brief Loads a file
	* \param file The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(kvi_i8_t & file) { return load((kvi_u8_t &)file); };

	/**
	* \brief Loads a file
	* \param szData The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(KviCString & szData);

	/**
	* \brief Loads a file
	* \param data The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(QByteArray & data);

	/**
	* \brief Loads a file
	* \param szData The file to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(QString & szData);

	/**
	* \brief Loads a file from a list
	* \param pData The list of files to load
	* \warning This function loads LITTLE ENDIAN DATA!
	* \return bool
	*/
	bool load(KviPointerList<KviCString> * pData);

	/**
	* \brief Skips the first occurrence of the given char for a given dimension
	* \param t The char to find and skip
	* \param uMaxDist The dimension of the search field
	* \return bool
	*/
	bool skipFirst(char t, unsigned int uMaxDist = 0xffffffff);

	/**
	* \brief Skips the first occurrence of the given string for a given dimension
	* \param szText The string to find and skip
	* \param uMaxDist The dimension of the search field
	* \return bool
	*/
	bool skipFirst(const KviCString & szText, unsigned int uMaxDist = 0xffffffff);
};

#endif //_KVI_FILE_H_