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
|
/*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module glib.Directory;
private import glib.ErrorG;
private import glib.GException;
private import glib.Str;
private import glib.c.functions;
public import glib.c.types;
public import gtkc.glibtypes;
/**
* An opaque structure representing an opened directory.
*/
public class Directory
{
/** the main Gtk struct */
protected GDir* gDir;
protected bool ownedRef;
/** Get the main Gtk struct */
public GDir* getDirectoryStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gDir;
}
/** the main Gtk struct as a void* */
protected void* getStruct()
{
return cast(void*)gDir;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GDir* gDir, bool ownedRef = false)
{
this.gDir = gDir;
this.ownedRef = ownedRef;
}
/**
* Closes the directory and deallocates all related resources.
*/
public void close()
{
g_dir_close(gDir);
}
/**
* Retrieves the name of another entry in the directory, or %NULL.
* The order of entries returned from this function is not defined,
* and may vary by file system or other operating-system dependent
* factors.
*
* %NULL may also be returned in case of errors. On Unix, you can
* check `errno` to find out if %NULL was returned because of an error.
*
* On Unix, the '.' and '..' entries are omitted, and the returned
* name is in the on-disk encoding.
*
* On Windows, as is true of all GLib functions which operate on
* filenames, the returned name is in UTF-8.
*
* Returns: The entry's name or %NULL if there are no
* more entries. The return value is owned by GLib and
* must not be modified or freed.
*/
public string readName()
{
return Str.toString(g_dir_read_name(gDir));
}
/**
* Resets the given directory. The next call to g_dir_read_name()
* will return the first entry again.
*/
public void rewind()
{
g_dir_rewind(gDir);
}
/**
* Creates a subdirectory in the preferred directory for temporary
* files (as returned by g_get_tmp_dir()).
*
* @tmpl should be a string in the GLib file name encoding containing
* a sequence of six 'X' characters, as the parameter to g_mkstemp().
* However, unlike these functions, the template should only be a
* basename, no directory components are allowed. If template is
* %NULL, a default template is used.
*
* Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not
* modified, and might thus be a read-only literal string.
*
* Params:
* tmpl = Template for directory name,
* as in g_mkdtemp(), basename only, or %NULL for a default template
*
* Returns: The actual name used. This string
* should be freed with g_free() when not needed any longer and is
* is in the GLib file name encoding. In case of errors, %NULL is
* returned and @error will be set.
*
* Since: 2.30
*
* Throws: GException on failure.
*/
public static string makeTmp(string tmpl)
{
GError* err = null;
auto retStr = g_dir_make_tmp(Str.toStringz(tmpl), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Opens a directory for reading. The names of the files in the
* directory can then be retrieved using g_dir_read_name(). Note
* that the ordering is not defined.
*
* Params:
* path = the path to the directory you are interested in. On Unix
* in the on-disk encoding. On Windows in UTF-8
* flags = Currently must be set to 0. Reserved for future use.
*
* Returns: a newly allocated #GDir on success, %NULL on failure.
* If non-%NULL, you must free the result with g_dir_close()
* when you are finished with it.
*
* Throws: GException on failure.
*/
public static Directory open(string path, uint flags)
{
GError* err = null;
auto __p = g_dir_open(Str.toStringz(path), flags, &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
if(__p is null)
{
return null;
}
return new Directory(cast(GDir*) __p);
}
}
|
