summaryrefslogtreecommitdiffstats
path: root/python/pyqt/sip/qt/qfile.sip
blob: 3252b852f61762c74a991d1b11a73e687488d63f (plain)
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
// This is the SIP interface definition for QFile.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyQt.
// 
// This copy of PyQt 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, or (at your option) any later
// version.
// 
// PyQt is supplied 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
// PyQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.


%ExportedDoc
<Sect2><Title>QFile</Title>
<FuncSynopsis>
        <FuncDef>bool <Function>open</Function></FuncDef>
        <ParamDef>int <Parameter>m</Parameter></ParamDef>
        <ParamDef>FILE *<Parameter>f</Parameter></ParamDef>
</FuncSynopsis>
<Para>
Not implemented.
</Para>

<FuncSynopsis>
        <FuncDef>Q_LONG <Function>readBlock</Function></FuncDef>
        <ParamDef>char *<Parameter>data</Parameter></ParamDef>
        <ParamDef>Q_ULONG <Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes a single <Literal>len</Literal> parameter.  The
<Literal>data</Literal> is returned if there was no error, otherwise
<Literal>None</Literal> is returned.
</Para>

<FuncSynopsis>
        <FuncDef>Q_LONG <Function>readLine</Function></FuncDef>
        <ParamDef>char *<Parameter>data</Parameter></ParamDef>
        <ParamDef>Q_ULONG <Parameter>maxlen</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes a single <Literal>maxlen</Literal> parameter.  The
<Literal>data</Literal> is returned if there was no error, otherwise
<Literal>None</Literal> is returned.
</Para>

<FuncSynopsis>
        <FuncDef>static void <Function>setDecodingFunction</Function></FuncDef>
        <ParamDef>EncoderFn <Parameter>f</Parameter></ParamDef>
</FuncSynopsis>
<Para>
Not yet implemented. (Qt v2+)
</Para>

<FuncSynopsis>
        <FuncDef>static void <Function>setEncodingFunction</Function></FuncDef>
        <ParamDef>EncoderFn <Parameter>f</Parameter></ParamDef>
</FuncSynopsis>
<Para>
Not yet implemented. (Qt v2+)
</Para>

<FuncSynopsis>
        <FuncDef>Q_LONG <Function>writeBlock</Function></FuncDef>
        <ParamDef>const char *<Parameter>data</Parameter></ParamDef>
        <ParamDef>Q_ULONG <Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
<Para>
<Literal>len</Literal> is derived from <Literal>data</Literal> and not passed
as a parameter.
</Para>
</Sect2>
%End


class QFile : QIODevice
{
%TypeHeaderCode
#include <qfile.h>
%End

public:
	QFile();
%If (- Qt_2_00)
	QFile(const char *);
%End
%If (Qt_2_00 -)
	QFile(const QString &);
%End

%If (- Qt_2_00)
	const char *name() const;
	void setName(const char *);
%End
%If (Qt_2_00 -)
	QString name() const;
	void setName(const QString &);
%End

%If (Qt_2_00 -)
	static QCString encodeName(const QString &);
	static QString decodeName(const QCString &);
//	static void setEncodingFunction(EncoderFn);
//	static void setDecodingFunction(DecoderFn);
%End

	bool exists() const;
%If (- Qt_2_00)
	static bool exists(const char *);
%End
%If (Qt_2_00 -)
	static bool exists(const QString &);
%End

	bool remove();
%If (- Qt_2_00)
	static bool remove(const char *);
%End
%If (Qt_2_00 -)
	static bool remove(const QString &);
%End

	bool open(int) /ReleaseGIL/;
//	bool open(int,FILE *) /ReleaseGIL/;
	bool open(int,int) /ReleaseGIL/;
	void close();
	void flush() /ReleaseGIL/;

%If (- Qt_3_0_0)
	uint size() const;
	int at() const;
	bool at(int);
%End
%If (Qt_3_0_0 -)
	Offset size() const;
	Offset at() const;
	bool at(Offset);
%End
	bool atEnd() const;

%If (- Qt_3_0_0)
	SIP_PYOBJECT readBlock(uint) /ReleaseGIL/ [int (char *,uint)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			int actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipSelfWasArg ? sipCpp -> QFile::readBlock(buf,a0) : sipCpp -> readBlock(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else if ((sipRes = PyString_FromStringAndSize(buf,actlen)) == NULL)
				sipIsErr = 1;

			sipFree((ANY *)buf);
		}
%End

	int writeBlock(const char * /Array/,uint /ArraySize/) /ReleaseGIL/;
%End
%If (Qt_3_0_0 -)
	SIP_PYOBJECT readBlock(Q_ULONG) /ReleaseGIL/ [Q_LONG (char *,Q_ULONG)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			Q_LONG actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipSelfWasArg ? sipCpp -> QFile::readBlock(buf,a0) : sipCpp -> readBlock(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else if ((sipRes = PyString_FromStringAndSize(buf,actlen)) == NULL)
				sipIsErr = 1;

			sipFree((ANY *)buf);
		}
%End


	Q_LONG writeBlock(const char * /Array/,
			  Q_ULONG /ArraySize/) /ReleaseGIL/;
%End
%If (Qt_2_00 - Qt_3_0_0)
	int writeBlock(const QByteArray &) /ReleaseGIL/;
%End
%If (Qt_3_0_0 -)
	Q_LONG writeBlock(const QByteArray &) /ReleaseGIL/;
%End

%If (- Qt_3_0_0)
	SIP_PYOBJECT readLine(uint) /ReleaseGIL/ [int (char *,uint)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			int actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipSelfWasArg ? sipCpp -> QFile::readLine(buf,a0) : sipCpp -> readLine(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				sipFree((ANY *)buf);

				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else
			{
				sipRes = PyString_FromStringAndSize(buf,actlen);

				sipFree((ANY *)buf);

				if (sipRes == NULL)
					sipIsErr = 1;
			}
		}
%End
%End
%If (Qt_3_0_0 -)
	SIP_PYOBJECT readLine(Q_ULONG) /ReleaseGIL/ [Q_LONG (char *,Q_ULONG)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			Q_LONG actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipSelfWasArg ? sipCpp -> QFile::readLine(buf,a0) : sipCpp -> readLine(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				sipFree((ANY *)buf);

				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else
			{
				sipRes = PyString_FromStringAndSize(buf,actlen);

				sipFree((ANY *)buf);

				if (sipRes == NULL)
					sipIsErr = 1;
			}
		}
%End
%End

%If (Qt_2_00 - Qt_3_0_0)
	int readLine(QString &,uint) /ReleaseGIL/;
%End
%If (Qt_3_0_0 -)
	Q_LONG readLine(QString &,Q_ULONG) /ReleaseGIL/;
%End

	int getch();
	int putch(int);
	int ungetch(int);

	int handle() const;

%If (Qt_3_2_0 -)
	QString errorString() const;
%End

protected:
%If (Qt_3_2_0 -)
	void setErrorString(const QString &);
%End

private:
	QFile(const QFile &);
};