summaryrefslogtreecommitdiffstats
path: root/python/pyqt/sip/qt/qdir.sip
blob: 906e805124c4e2c2acf0a92039d2e53b73c806ec (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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
// This is the SIP interface definition for QDir and QFileInfoList.
//
// 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


%ExportedDoc
<Sect2><Title>QDir</Title>
<Para>
<Literal>QDir</Literal> is fully implemented, including the Python
<Literal>len</Literal>, <Literal>[]</Literal> (for reading slices and
individual elements), <Literal>==</Literal>, <Literal>!=</Literal> and
<Literal>in</Literal> operators
</Para>
</Sect2>

<Sect2><Title>QFileInfoList</Title>
<Para>
This class isn't implemented.  Whenever a <Literal>QFileInfoList</Literal> is
the return type of a function or the type of an argument, a Python list of
<Literal>QFileInfo</Literal> instances is used instead.
</Para>
</Sect2>
%End


%MappedType QFileInfoList
{
%TypeHeaderCode
#include <qdir.h>
#include "sipqtQFileInfo.h"
%End

%ConvertFromTypeCode
	PyObject *pl;
	QFileInfo *obj;

	// Convert the list.

	if ((pl = PyList_New(0)) == NULL)
		return NULL;

	for (QFileInfoListIterator it(*sipCpp); (obj = it.current()) != NULL; ++it)
	{
		PyObject *inst;

		if ((inst = sipConvertFromInstance(obj,sipClass_QFileInfo,sipTransferObj)) == NULL || PyList_Append(pl,inst) < 0)
		{
			Py_XDECREF(inst);
			Py_DECREF(pl);

			return NULL;
		}

		Py_DECREF(inst);
	}

	return pl;
%End

%ConvertToTypeCode
	// Convert a Python list of QFileInfo instances to a QFileInfoList on
	// the heap.

	if (sipIsErr == NULL)
	{
		if (!PyList_Check(sipPy))
			return 0;

		for (int i = 0; i < PyList_GET_SIZE(sipPy); ++i)
			if (!sipCanConvertToInstance(PyList_GET_ITEM(sipPy,i),sipClass_QFileInfo,0))
				return 0;

		return 1;
	}

	QFileInfoList *qfil = new QFileInfoList;
 
	for (int i = 0; i < PyList_GET_SIZE(sipPy); ++i)
	{
		QFileInfo *qfi;
 
		// We apply the transfer to the list itself, not the elements.
		// Note that any temporary element will never be destroyed.
		// There is nothing that can be done about this.
		qfi = reinterpret_cast<QFileInfo *>(sipConvertToInstance(PyList_GET_ITEM(sipPy,i),sipClass_QFileInfo,0,0,0,sipIsErr));

		if (*sipIsErr)
		{
			delete qfil;
			return 0;
		}
 
		qfil -> append(qfi);
	}
 
	*sipCppPtr = qfil;

	return sipGetState(sipTransferObj);
%End
};


class QDir
{
%TypeHeaderCode
#include <qdir.h>
%End

public:
	enum FilterSpec {
		Dirs,
		Files,
		Drives,
		NoSymLinks,
		All,
		TypeMask,

		Readable,
		Writable,
		Executable,
		RWEMask,

		Modified,
		Hidden,
		System,
		AccessMask,

		DefaultFilter
	};

	enum SortSpec {
		Name,
		Time,
		Size,
		Unsorted,
		SortByMask,

		DirsFirst,
		Reversed,
		IgnoreCase,
		DefaultSort
	};

	QDir();
%If (- Qt_2_00)
	QDir(const char *,const char * = 0,int = Name | IgnoreCase,int = All);
%End
%If (Qt_2_00 -)
	QDir(const QString &,const QString & = QString::null,
	     int = Name | IgnoreCase,int = All);
%End
	QDir(const QDir &);

%If (- Qt_2_00)
	void setPath(const char *);
	const char *path() const;
	QString absPath() const;
	QString canonicalPath() const;

	QString dirName() const;
	QString filePath(const char *,bool = 1) const;
	QString absFilePath(const char *,bool = 1) const;

	static QString convertSeparators(const char *);

	bool cd(const char *,bool = 1);
	bool cdUp();

	const char *nameFilter() const;
	void setNameFilter(const char *);
%End
%If (Qt_2_00 -)
	virtual void setPath(const QString &);
	virtual QString path() const;
	virtual QString absPath() const;
	virtual QString canonicalPath() const;

	virtual QString dirName() const;
	virtual QString filePath(const QString &,bool = 1) const;
	virtual QString absFilePath(const QString &,bool = 1) const;

	static QString convertSeparators(const QString &);

	virtual bool cd(const QString &,bool = 1);
	virtual bool cdUp();

	QString nameFilter() const;
	virtual void setNameFilter(const QString &);
%End
	FilterSpec filter() const;
%If (- Qt_2_00)
	void setFilter(int);
%End
%If (Qt_2_00 -)
	virtual void setFilter(int);
%End
	SortSpec sorting() const;
%If (- Qt_2_00)
	void setSorting(int);
%End
%If (Qt_2_00 -)
	virtual void setSorting(int);
%End

	bool matchAllDirs() const;
%If (- Qt_2_00)
	void setMatchAllDirs(bool);
%End
%If (Qt_2_00 -)
	virtual void setMatchAllDirs(bool);
%End

	uint count() const;

	int __len__() const;
%MethodCode
		Py_BEGIN_ALLOW_THREADS
		sipRes = sipCpp -> count();
		Py_END_ALLOW_THREADS
%End

	QString operator[](int) const;
%MethodCode
		int len;

		Py_BEGIN_ALLOW_THREADS
		len = sipCpp -> count();
		Py_END_ALLOW_THREADS

		if ((a0 = (int)sipConvertFromSequenceIndex(a0,len)) < 0)
			sipIsErr = 1;
		else
		{
			Py_BEGIN_ALLOW_THREADS
			sipRes = new QString((*sipCpp)[a0]);
			Py_END_ALLOW_THREADS
		}
%End

	QStringList operator[](SIP_PYSLICE) const;
%MethodCode
#if PY_VERSION_HEX >= 0x02050000
		Py_ssize_t len, start, stop, step, slicelength, i;
#else
		int len, start, stop, step, slicelength, i;
#endif

		Py_BEGIN_ALLOW_THREADS
		len = sipCpp -> count();
		Py_END_ALLOW_THREADS

		if (sipConvertFromSliceObject(a0,len,&start,&stop,&step,&slicelength) < 0)
			sipIsErr = 1;
		else
		{
			Py_BEGIN_ALLOW_THREADS
			sipRes = new QStringList();

			for (i = 0; i < slicelength; ++i)
			{
				(*sipRes) += (*sipCpp)[start];
				start += step;
			}
			Py_END_ALLOW_THREADS
		}
%End

	int __contains__(const QString &) const;
%MethodCode
		Py_BEGIN_ALLOW_THREADS
		sipRes = (sipCpp -> entryList().findIndex(*a0) >= 0);
		Py_END_ALLOW_THREADS
%End

%If (- Qt_2_00)
	const QStrList *entryList(int = DefaultFilter,int = DefaultSort) const;
	const QStrList *entryList(const char *,int = DefaultFilter,
				  int = DefaultSort) const;
	const QFileInfoList *entryInfoList(int = DefaultFilter,
					   int = DefaultSort) const;
	const QFileInfoList *entryInfoList(const char *,int = DefaultFilter,
					   int = DefaultSort) const;
%End
%If (Qt_2_00 -)
	virtual QStrList encodedEntryList(int = DefaultFilter,
					  int = DefaultSort) const;
	virtual QStrList encodedEntryList(const QString &,int = DefaultFilter,
					  int = DefaultSort) const;
	virtual QStringList entryList(int = DefaultFilter,
				      int = DefaultSort) const;
	virtual QStringList entryList(const QString &,int = DefaultFilter,
				      int = DefaultSort) const;
	virtual const QFileInfoList *entryInfoList(int = DefaultFilter,
						   int = DefaultSort) const;
	virtual const QFileInfoList *entryInfoList(const QString &,
						   int = DefaultFilter,
						   int = DefaultSort) const;
%End

	static const QFileInfoList *drives();

%If (- Qt_2_00)
	bool mkdir(const char *,bool = 1) const;
	bool rmdir(const char *,bool = 1) const;

	bool isReadable() const;
	bool exists() const;
	bool isRoot() const;

	bool isRelative() const;
	void convertToAbs();

	bool operator==(const QDir &) const;
	bool operator!=(const QDir &) const;

	bool remove(const char *,bool = 1);
	bool rename(const char *,const char *,bool = 1);
	bool exists(const char *,bool = 1);
%End
%If (Qt_2_00 -)
	virtual bool mkdir(const QString &,bool = 1) const;
	virtual bool rmdir(const QString &,bool = 1) const;

	virtual bool isReadable() const;
	virtual bool exists() const;
	virtual bool isRoot() const;

	virtual bool isRelative() const;
	virtual void convertToAbs();

	virtual bool remove(const QString &,bool = 1);
	virtual bool rename(const QString &,const QString &,bool = 1);
	virtual bool exists(const QString &,bool = 1);
%End

	static char separator();

%If (- Qt_2_00)
	static bool setCurrent(const char *);
%End
%If (Qt_2_00 -)
	static bool setCurrent(const QString &);
%End
	static QDir current();
	static QDir home();
	static QDir root();
	static QString currentDirPath();
	static QString homeDirPath();
	static QString rootDirPath();

%If (- Qt_2_00)
	static bool match(const char *,const char *);
	static QString cleanDirPath(const char *);
	static bool isRelativePath(const char *);
%End
%If (Qt_2_1_0 -)
	static bool match(const QStringList &,const QString &);
%End
%If (Qt_2_00 -)
	static bool match(const QString &,const QString &);
	static QString cleanDirPath(const QString &);
	static bool isRelativePath(const QString &);
%End
%If (Qt_3_1_0 -)
	void refresh() const;
%End
};