1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module glib.Util;
26 
27 private import glib.Str;
28 private import gtkc.glib;
29 public  import gtkc.glibtypes;
30 
31 
32 /** */
33 public struct Util
34 {
35 	/**
36 	 * Behaves exactly like g_build_filename(), but takes the path elements
37 	 * as a string array, instead of varargs. This function is mainly
38 	 * meant for language bindings.
39 	 *
40 	 * Params:
41 	 *     args = strings containing the path elements.
42 	 *
43 	 * Return: a newly-allocated string that must be freed with g_free().
44 	 *
45 	 * Since: 2.8
46 	 */
47 	public static string buildFilename(string[] firstElement ... )
48 	{
49 		return Str.toString(g_build_filenamev(Str.toStringzArray(firstElement)));
50 	}
51 	
52 	/**
53 	 * Behaves exactly like g_build_path(), but takes the path elements
54 	 * as a string array, instead of varargs. This function is mainly
55 	 * meant for language bindings.
56 	 *
57 	 * Params:
58 	 *     separator = a string used to separator the elements of the path.
59 	 *     args = strings containing the path elements.
60 	 *
61 	 * Return: a newly-allocated string that must be freed with g_free().
62 	 *
63 	 * Since: 2.8
64 	 */
65 	public static string buildPath(string separator, string[] firstElement ... )
66 	{
67 		return Str.toString(g_build_pathv(Str.toStringz(separator), Str.toStringzArray(firstElement)));
68 	}
69 
70 	/**
71 	 */
72 
73 	/**
74 	 * Specifies a function to be called at normal program termination.
75 	 *
76 	 * Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
77 	 * macro that maps to a call to the atexit() function in the C
78 	 * library. This means that in case the code that calls g_atexit(),
79 	 * i.e. atexit(), is in a DLL, the function will be called when the
80 	 * DLL is detached from the program. This typically makes more sense
81 	 * than that the function is called when the GLib DLL is detached,
82 	 * which happened earlier when g_atexit() was a function in the GLib
83 	 * DLL.
84 	 *
85 	 * The behaviour of atexit() in the context of dynamically loaded
86 	 * modules is not formally specified and varies wildly.
87 	 *
88 	 * On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
89 	 * loaded module which is unloaded before the program terminates might
90 	 * well cause a crash at program exit.
91 	 *
92 	 * Some POSIX systems implement atexit() like Windows, and have each
93 	 * dynamically loaded module maintain an own atexit chain that is
94 	 * called when the module is unloaded.
95 	 *
96 	 * On other POSIX systems, before a dynamically loaded module is
97 	 * unloaded, the registered atexit functions (if any) residing in that
98 	 * module are called, regardless where the code that registered them
99 	 * resided. This is presumably the most robust approach.
100 	 *
101 	 * As can be seen from the above, for portability it's best to avoid
102 	 * calling g_atexit() (or atexit()) except in the main executable of a
103 	 * program.
104 	 *
105 	 * Deprecated: It is best to avoid g_atexit().
106 	 *
107 	 * Params:
108 	 *     func = the function to call on normal program termination.
109 	 */
110 	public static void atexit(GVoidFunc func)
111 	{
112 		g_atexit(func);
113 	}
114 
115 	/**
116 	 * Gets the name of the file without any leading directory
117 	 * components. It returns a pointer into the given file name
118 	 * string.
119 	 *
120 	 * Deprecated: Use g_path_get_basename() instead, but notice
121 	 * that g_path_get_basename() allocates new memory for the
122 	 * returned string, unlike this function which returns a pointer
123 	 * into the argument.
124 	 *
125 	 * Params:
126 	 *     fileName = the name of the file
127 	 *
128 	 * Return: the name of the file without any leading
129 	 *     directory components
130 	 */
131 	public static string basename(string fileName)
132 	{
133 		return Str.toString(g_basename(Str.toStringz(fileName)));
134 	}
135 
136 	/**
137 	 * Find the position of the first bit set in @mask, searching
138 	 * from (but not including) @nth_bit upwards. Bits are numbered
139 	 * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
140 	 * usually). To start searching from the 0th bit, set @nth_bit to -1.
141 	 *
142 	 * Params:
143 	 *     mask = a #gulong containing flags
144 	 *     nthBit = the index of the bit to start the search from
145 	 *
146 	 * Return: the index of the first bit set which is higher than @nth_bit, or -1
147 	 *     if no higher bits are set
148 	 */
149 	public static int bitNthLsf(gulong mask, int nthBit)
150 	{
151 		return g_bit_nth_lsf(mask, nthBit);
152 	}
153 
154 	/**
155 	 * Find the position of the first bit set in @mask, searching
156 	 * from (but not including) @nth_bit downwards. Bits are numbered
157 	 * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
158 	 * usually). To start searching from the last bit, set @nth_bit to
159 	 * -1 or GLIB_SIZEOF_LONG * 8.
160 	 *
161 	 * Params:
162 	 *     mask = a #gulong containing flags
163 	 *     nthBit = the index of the bit to start the search from
164 	 *
165 	 * Return: the index of the first bit set which is lower than @nth_bit, or -1
166 	 *     if no lower bits are set
167 	 */
168 	public static int bitNthMsf(gulong mask, int nthBit)
169 	{
170 		return g_bit_nth_msf(mask, nthBit);
171 	}
172 
173 	/**
174 	 * Gets the number of bits used to hold @number,
175 	 * e.g. if @number is 4, 3 bits are needed.
176 	 *
177 	 * Params:
178 	 *     number = a #guint
179 	 *
180 	 * Return: the number of bits used to hold @number
181 	 */
182 	public static uint bitStorage(gulong number)
183 	{
184 		return g_bit_storage(number);
185 	}
186 
187 	/**
188 	 * Returns the value of the environment variable @variable in the
189 	 * provided list @envp.
190 	 *
191 	 * Params:
192 	 *     envp = an environment
193 	 *         list (eg, as returned from g_get_environ()), or %NULL
194 	 *         for an empty environment list
195 	 *     variable = the environment variable to get
196 	 *
197 	 * Return: the value of the environment variable, or %NULL if
198 	 *     the environment variable is not set in @envp. The returned
199 	 *     string is owned by @envp, and will be freed if @variable is
200 	 *     set or unset again.
201 	 *
202 	 * Since: 2.32
203 	 */
204 	public static string environGetenv(string[] envp, string variable)
205 	{
206 		return Str.toString(g_environ_getenv(Str.toStringzArray(envp), Str.toStringz(variable)));
207 	}
208 
209 	/**
210 	 * Sets the environment variable @variable in the provided list
211 	 * @envp to @value.
212 	 *
213 	 * Params:
214 	 *     envp = an
215 	 *         environment list that can be freed using g_strfreev() (e.g., as
216 	 *         returned from g_get_environ()), or %NULL for an empty
217 	 *         environment list
218 	 *     variable = the environment variable to set, must not contain '='
219 	 *     value = the value for to set the variable to
220 	 *     overwrite = whether to change the variable if it already exists
221 	 *
222 	 * Return: the
223 	 *     updated environment list. Free it using g_strfreev().
224 	 *
225 	 * Since: 2.32
226 	 */
227 	public static string[] environSetenv(string[] envp, string variable, string value, bool overwrite)
228 	{
229 		auto retStr = g_environ_setenv(Str.toStringzArray(envp), Str.toStringz(variable), Str.toStringz(value), overwrite);
230 		
231 		scope(exit) Str.freeStringArray(retStr);
232 		return Str.toStringArray(retStr);
233 	}
234 
235 	/**
236 	 * Removes the environment variable @variable from the provided
237 	 * environment @envp.
238 	 *
239 	 * Params:
240 	 *     envp = an environment
241 	 *         list that can be freed using g_strfreev() (e.g., as returned from g_get_environ()),
242 	 *         or %NULL for an empty environment list
243 	 *     variable = the environment variable to remove, must not contain '='
244 	 *
245 	 * Return: the
246 	 *     updated environment list. Free it using g_strfreev().
247 	 *
248 	 * Since: 2.32
249 	 */
250 	public static string[] environUnsetenv(string[] envp, string variable)
251 	{
252 		auto retStr = g_environ_unsetenv(Str.toStringzArray(envp), Str.toStringz(variable));
253 		
254 		scope(exit) Str.freeStringArray(retStr);
255 		return Str.toStringArray(retStr);
256 	}
257 
258 	/**
259 	 * Locates the first executable named @program in the user's path, in the
260 	 * same way that execvp() would locate it. Returns an allocated string
261 	 * with the absolute path name, or %NULL if the program is not found in
262 	 * the path. If @program is already an absolute path, returns a copy of
263 	 * @program if @program exists and is executable, and %NULL otherwise.
264 	 *
265 	 * On Windows, if @program does not have a file type suffix, tries
266 	 * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
267 	 * the `PATHEXT` environment variable.
268 	 *
269 	 * On Windows, it looks for the file in the same way as CreateProcess()
270 	 * would. This means first in the directory where the executing
271 	 * program was loaded from, then in the current directory, then in the
272 	 * Windows 32-bit system directory, then in the Windows directory, and
273 	 * finally in the directories in the `PATH` environment variable. If
274 	 * the program is found, the return value contains the full name
275 	 * including the type suffix.
276 	 *
277 	 * Params:
278 	 *     program = a program name in the GLib file name encoding
279 	 *
280 	 * Return: a newly-allocated string with the absolute path, or %NULL
281 	 */
282 	public static string findProgramInPath(string program)
283 	{
284 		auto retStr = g_find_program_in_path(Str.toStringz(program));
285 		
286 		scope(exit) Str.freeString(retStr);
287 		return Str.toString(retStr);
288 	}
289 
290 	/**
291 	 * Formats a size (for example the size of a file) into a human readable
292 	 * string.  Sizes are rounded to the nearest size prefix (kB, MB, GB)
293 	 * and are displayed rounded to the nearest tenth. E.g. the file size
294 	 * 3292528 bytes will be converted into the string "3.2 MB".
295 	 *
296 	 * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
297 	 *
298 	 * This string should be freed with g_free() when not needed any longer.
299 	 *
300 	 * See g_format_size_full() for more options about how the size might be
301 	 * formatted.
302 	 *
303 	 * Params:
304 	 *     size = a size in bytes
305 	 *
306 	 * Return: a newly-allocated formatted string containing a human readable
307 	 *     file size
308 	 *
309 	 * Since: 2.30
310 	 */
311 	public static string formatSize(ulong size)
312 	{
313 		auto retStr = g_format_size(size);
314 		
315 		scope(exit) Str.freeString(retStr);
316 		return Str.toString(retStr);
317 	}
318 
319 	/**
320 	 * Formats a size (for example the size of a file) into a human
321 	 * readable string. Sizes are rounded to the nearest size prefix
322 	 * (KB, MB, GB) and are displayed rounded to the nearest tenth.
323 	 * E.g. the file size 3292528 bytes will be converted into the
324 	 * string "3.1 MB".
325 	 *
326 	 * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
327 	 *
328 	 * This string should be freed with g_free() when not needed any longer.
329 	 *
330 	 * Deprecated: This function is broken due to its use of SI
331 	 * suffixes to denote IEC units. Use g_format_size() instead.
332 	 *
333 	 * Params:
334 	 *     size = a size in bytes
335 	 *
336 	 * Return: a newly-allocated formatted string containing a human
337 	 *     readable file size
338 	 *
339 	 * Since: 2.16
340 	 */
341 	public static string formatSizeForDisplay(long size)
342 	{
343 		auto retStr = g_format_size_for_display(size);
344 		
345 		scope(exit) Str.freeString(retStr);
346 		return Str.toString(retStr);
347 	}
348 
349 	/**
350 	 * Formats a size.
351 	 *
352 	 * This function is similar to g_format_size() but allows for flags
353 	 * that modify the output. See #GFormatSizeFlags.
354 	 *
355 	 * Params:
356 	 *     size = a size in bytes
357 	 *     flags = #GFormatSizeFlags to modify the output
358 	 *
359 	 * Return: a newly-allocated formatted string containing a human
360 	 *     readable file size
361 	 *
362 	 * Since: 2.30
363 	 */
364 	public static string formatSizeFull(ulong size, GFormatSizeFlags flags)
365 	{
366 		auto retStr = g_format_size_full(size, flags);
367 		
368 		scope(exit) Str.freeString(retStr);
369 		return Str.toString(retStr);
370 	}
371 
372 	/**
373 	 * Gets a human-readable name for the application, as set by
374 	 * g_set_application_name(). This name should be localized if
375 	 * possible, and is intended for display to the user.  Contrast with
376 	 * g_get_prgname(), which gets a non-localized name. If
377 	 * g_set_application_name() has not been called, returns the result of
378 	 * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
379 	 * been called).
380 	 *
381 	 * Return: human-readable application name. may return %NULL
382 	 *
383 	 * Since: 2.2
384 	 */
385 	public static string getApplicationName()
386 	{
387 		return Str.toString(g_get_application_name());
388 	}
389 
390 	/**
391 	 * Gets the list of environment variables for the current process.
392 	 *
393 	 * The list is %NULL terminated and each item in the list is of the
394 	 * form 'NAME=VALUE'.
395 	 *
396 	 * This is equivalent to direct access to the 'environ' global variable,
397 	 * except portable.
398 	 *
399 	 * The return value is freshly allocated and it should be freed with
400 	 * g_strfreev() when it is no longer needed.
401 	 *
402 	 * Return: the list of
403 	 *     environment variables
404 	 *
405 	 * Since: 2.28
406 	 */
407 	public static string[] getEnviron()
408 	{
409 		auto retStr = g_get_environ();
410 		
411 		scope(exit) Str.freeStringArray(retStr);
412 		return Str.toStringArray(retStr);
413 	}
414 
415 	/**
416 	 * Gets the current directory.
417 	 *
418 	 * The returned string should be freed when no longer needed.
419 	 * The encoding of the returned string is system defined.
420 	 * On Windows, it is always UTF-8.
421 	 *
422 	 * Since GLib 2.40, this function will return the value of the "PWD"
423 	 * environment variable if it is set and it happens to be the same as
424 	 * the current directory.  This can make a difference in the case that
425 	 * the current directory is the target of a symbolic link.
426 	 *
427 	 * Return: the current directory
428 	 */
429 	public static string getCurrentDir()
430 	{
431 		auto retStr = g_get_current_dir();
432 		
433 		scope(exit) Str.freeString(retStr);
434 		return Str.toString(retStr);
435 	}
436 
437 	/**
438 	 * Gets the current user's home directory.
439 	 *
440 	 * As with most UNIX tools, this function will return the value of the
441 	 * `HOME` environment variable if it is set to an existing absolute path
442 	 * name, falling back to the `passwd` file in the case that it is unset.
443 	 *
444 	 * If the path given in `HOME` is non-absolute, does not exist, or is
445 	 * not a directory, the result is undefined.
446 	 *
447 	 * Before version 2.36 this function would ignore the `HOME` environment
448 	 * variable, taking the value from the `passwd` database instead. This was
449 	 * changed to increase the compatibility of GLib with other programs (and
450 	 * the XDG basedir specification) and to increase testability of programs
451 	 * based on GLib (by making it easier to run them from test frameworks).
452 	 *
453 	 * If your program has a strong requirement for either the new or the
454 	 * old behaviour (and if you don't wish to increase your GLib
455 	 * dependency to ensure that the new behaviour is in effect) then you
456 	 * should either directly check the `HOME` environment variable yourself
457 	 * or unset it before calling any functions in GLib.
458 	 *
459 	 * Return: the current user's home directory
460 	 */
461 	public static string getHomeDir()
462 	{
463 		return Str.toString(g_get_home_dir());
464 	}
465 
466 	/**
467 	 * Return a name for the machine.
468 	 *
469 	 * The returned name is not necessarily a fully-qualified domain name,
470 	 * or even present in DNS or some other name service at all. It need
471 	 * not even be unique on your local network or site, but usually it
472 	 * is. Callers should not rely on the return value having any specific
473 	 * properties like uniqueness for security purposes. Even if the name
474 	 * of the machine is changed while an application is running, the
475 	 * return value from this function does not change. The returned
476 	 * string is owned by GLib and should not be modified or freed. If no
477 	 * name can be determined, a default fixed string "localhost" is
478 	 * returned.
479 	 *
480 	 * Return: the host name of the machine.
481 	 *
482 	 * Since: 2.8
483 	 */
484 	public static string getHostName()
485 	{
486 		return Str.toString(g_get_host_name());
487 	}
488 
489 	/**
490 	 * Gets the name of the program. This name should not be localized,
491 	 * in contrast to g_get_application_name().
492 	 *
493 	 * If you are using GDK or GTK+ the program name is set in gdk_init(),
494 	 * which is called by gtk_init(). The program name is found by taking
495 	 * the last component of @argv[0].
496 	 *
497 	 * Return: the name of the program. The returned string belongs
498 	 *     to GLib and must not be modified or freed.
499 	 */
500 	public static string getPrgname()
501 	{
502 		return Str.toString(g_get_prgname());
503 	}
504 
505 	/**
506 	 * Gets the real name of the user. This usually comes from the user's
507 	 * entry in the `passwd` file. The encoding of the returned string is
508 	 * system-defined. (On Windows, it is, however, always UTF-8.) If the
509 	 * real user name cannot be determined, the string "Unknown" is
510 	 * returned.
511 	 *
512 	 * Return: the user's real name.
513 	 */
514 	public static string getRealName()
515 	{
516 		return Str.toString(g_get_real_name());
517 	}
518 
519 	/**
520 	 * Returns an ordered list of base directories in which to access
521 	 * system-wide configuration information.
522 	 *
523 	 * On UNIX platforms this is determined using the mechanisms described
524 	 * in the
525 	 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
526 	 * In this case the list of directories retrieved will be `XDG_CONFIG_DIRS`.
527 	 *
528 	 * On Windows is the directory that contains application data for all users.
529 	 * A typical path is C:\Documents and Settings\All Users\Application Data.
530 	 * This folder is used for application data that is not user specific.
531 	 * For example, an application can store a spell-check dictionary, a database
532 	 * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
533 	 * This information will not roam and is available to anyone using the computer.
534 	 *
535 	 * Return: a %NULL-terminated array of strings owned by GLib that must
536 	 *     not be modified or freed.
537 	 *
538 	 * Since: 2.6
539 	 */
540 	public static string[] getSystemConfigDirs()
541 	{
542 		return Str.toStringArray(g_get_system_config_dirs());
543 	}
544 
545 	/**
546 	 * Returns an ordered list of base directories in which to access
547 	 * system-wide application data.
548 	 *
549 	 * On UNIX platforms this is determined using the mechanisms described
550 	 * in the
551 	 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec)
552 	 * In this case the list of directories retrieved will be XDG_DATA_DIRS.
553 	 *
554 	 * On Windows the first elements in the list are the Application Data
555 	 * and Documents folders for All Users. (These can be determined only
556 	 * on Windows 2000 or later and are not present in the list on other
557 	 * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
558 	 * CSIDL_COMMON_DOCUMENTS.
559 	 *
560 	 * Then follows the "share" subfolder in the installation folder for
561 	 * the package containing the DLL that calls this function, if it can
562 	 * be determined.
563 	 *
564 	 * Finally the list contains the "share" subfolder in the installation
565 	 * folder for GLib, and in the installation folder for the package the
566 	 * application's .exe file belongs to.
567 	 *
568 	 * The installation folders above are determined by looking up the
569 	 * folder where the module (DLL or EXE) in question is located. If the
570 	 * folder's name is "bin", its parent is used, otherwise the folder
571 	 * itself.
572 	 *
573 	 * Note that on Windows the returned list can vary depending on where
574 	 * this function is called.
575 	 *
576 	 * Return: a %NULL-terminated array of strings owned by GLib that must
577 	 *     not be modified or freed.
578 	 *
579 	 * Since: 2.6
580 	 */
581 	public static string[] getSystemDataDirs()
582 	{
583 		return Str.toStringArray(g_get_system_data_dirs());
584 	}
585 
586 	/**
587 	 * Gets the directory to use for temporary files.
588 	 *
589 	 * On UNIX, this is taken from the `TMPDIR` environment variable.
590 	 * If the variable is not set, `P_tmpdir` is
591 	 * used, as defined by the system C library. Failing that, a
592 	 * hard-coded default of "/tmp" is returned.
593 	 *
594 	 * On Windows, the `TEMP` environment variable is used, with the
595 	 * root directory of the Windows installation (eg: "C:\") used
596 	 * as a default.
597 	 *
598 	 * The encoding of the returned string is system-defined. On Windows,
599 	 * it is always UTF-8. The return value is never %NULL or the empty
600 	 * string.
601 	 *
602 	 * Return: the directory to use for temporary files.
603 	 */
604 	public static string getTmpDir()
605 	{
606 		return Str.toString(g_get_tmp_dir());
607 	}
608 
609 	/**
610 	 * Returns a base directory in which to store non-essential, cached
611 	 * data specific to particular user.
612 	 *
613 	 * On UNIX platforms this is determined using the mechanisms described
614 	 * in the
615 	 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
616 	 * In this case the directory retrieved will be XDG_CACHE_HOME.
617 	 *
618 	 * On Windows is the directory that serves as a common repository for
619 	 * temporary Internet files. A typical path is
620 	 * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
621 	 * See documentation for CSIDL_INTERNET_CACHE.
622 	 *
623 	 * Return: a string owned by GLib that must not be modified
624 	 *     or freed.
625 	 *
626 	 * Since: 2.6
627 	 */
628 	public static string getUserCacheDir()
629 	{
630 		return Str.toString(g_get_user_cache_dir());
631 	}
632 
633 	/**
634 	 * Returns a base directory in which to store user-specific application
635 	 * configuration information such as user preferences and settings.
636 	 *
637 	 * On UNIX platforms this is determined using the mechanisms described
638 	 * in the
639 	 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
640 	 * In this case the directory retrieved will be `XDG_CONFIG_HOME`.
641 	 *
642 	 * On Windows this is the folder to use for local (as opposed to
643 	 * roaming) application data. See documentation for
644 	 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
645 	 * what g_get_user_data_dir() returns.
646 	 *
647 	 * Return: a string owned by GLib that must not be modified
648 	 *     or freed.
649 	 *
650 	 * Since: 2.6
651 	 */
652 	public static string getUserConfigDir()
653 	{
654 		return Str.toString(g_get_user_config_dir());
655 	}
656 
657 	/**
658 	 * Returns a base directory in which to access application data such
659 	 * as icons that is customized for a particular user.
660 	 *
661 	 * On UNIX platforms this is determined using the mechanisms described
662 	 * in the
663 	 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
664 	 * In this case the directory retrieved will be `XDG_DATA_HOME`.
665 	 *
666 	 * On Windows this is the folder to use for local (as opposed to
667 	 * roaming) application data. See documentation for
668 	 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
669 	 * what g_get_user_config_dir() returns.
670 	 *
671 	 * Return: a string owned by GLib that must not be modified
672 	 *     or freed.
673 	 *
674 	 * Since: 2.6
675 	 */
676 	public static string getUserDataDir()
677 	{
678 		return Str.toString(g_get_user_data_dir());
679 	}
680 
681 	/**
682 	 * Gets the user name of the current user. The encoding of the returned
683 	 * string is system-defined. On UNIX, it might be the preferred file name
684 	 * encoding, or something else, and there is no guarantee that it is even
685 	 * consistent on a machine. On Windows, it is always UTF-8.
686 	 *
687 	 * Return: the user name of the current user.
688 	 */
689 	public static string getUserName()
690 	{
691 		return Str.toString(g_get_user_name());
692 	}
693 
694 	/**
695 	 * Returns a directory that is unique to the current user on the local
696 	 * system.
697 	 *
698 	 * On UNIX platforms this is determined using the mechanisms described
699 	 * in the
700 	 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
701 	 * This is the directory
702 	 * specified in the `XDG_RUNTIME_DIR` environment variable.
703 	 * In the case that this variable is not set, GLib will issue a warning
704 	 * message to stderr and return the value of g_get_user_cache_dir().
705 	 *
706 	 * On Windows this is the folder to use for local (as opposed to
707 	 * roaming) application data. See documentation for
708 	 * CSIDL_LOCAL_APPDATA.  Note that on Windows it thus is the same as
709 	 * what g_get_user_config_dir() returns.
710 	 *
711 	 * Return: a string owned by GLib that must not be modified or freed.
712 	 *
713 	 * Since: 2.28
714 	 */
715 	public static string getUserRuntimeDir()
716 	{
717 		return Str.toString(g_get_user_runtime_dir());
718 	}
719 
720 	/**
721 	 * Returns the full path of a special directory using its logical id.
722 	 *
723 	 * On UNIX this is done using the XDG special user directories.
724 	 * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
725 	 * falls back to `$HOME/Desktop` when XDG special user directories have
726 	 * not been set up.
727 	 *
728 	 * Depending on the platform, the user might be able to change the path
729 	 * of the special directory without requiring the session to restart; GLib
730 	 * will not reflect any change once the special directories are loaded.
731 	 *
732 	 * Params:
733 	 *     directory = the logical id of special directory
734 	 *
735 	 * Return: the path to the specified special directory, or %NULL
736 	 *     if the logical id was not found. The returned string is owned by
737 	 *     GLib and should not be modified or freed.
738 	 *
739 	 * Since: 2.14
740 	 */
741 	public static string getUserSpecialDir(GUserDirectory directory)
742 	{
743 		return Str.toString(g_get_user_special_dir(directory));
744 	}
745 
746 	/**
747 	 * Returns the value of an environment variable.
748 	 *
749 	 * On UNIX, the name and value are byte strings which might or might not
750 	 * be in some consistent character set and encoding. On Windows, they are
751 	 * in UTF-8.
752 	 * On Windows, in case the environment variable's value contains
753 	 * references to other environment variables, they are expanded.
754 	 *
755 	 * Params:
756 	 *     variable = the environment variable to get
757 	 *
758 	 * Return: the value of the environment variable, or %NULL if
759 	 *     the environment variable is not found. The returned string
760 	 *     may be overwritten by the next call to g_getenv(), g_setenv()
761 	 *     or g_unsetenv().
762 	 */
763 	public static string getenv(string variable)
764 	{
765 		return Str.toString(g_getenv(Str.toStringz(variable)));
766 	}
767 
768 	/**
769 	 * Gets the names of all variables set in the environment.
770 	 *
771 	 * Programs that want to be portable to Windows should typically use
772 	 * this function and g_getenv() instead of using the environ array
773 	 * from the C library directly. On Windows, the strings in the environ
774 	 * array are in system codepage encoding, while in most of the typical
775 	 * use cases for environment variables in GLib-using programs you want
776 	 * the UTF-8 encoding that this function and g_getenv() provide.
777 	 *
778 	 * Return: a %NULL-terminated
779 	 *     list of strings which must be freed with g_strfreev().
780 	 *
781 	 * Since: 2.8
782 	 */
783 	public static string[] listenv()
784 	{
785 		auto retStr = g_listenv();
786 		
787 		scope(exit) Str.freeStringArray(retStr);
788 		return Str.toStringArray(retStr);
789 	}
790 
791 	/**
792 	 * Set the pointer at the specified location to %NULL.
793 	 *
794 	 * Params:
795 	 *     nullifyLocation = the memory address of the pointer.
796 	 */
797 	public static void nullifyPointer(void** nullifyLocation)
798 	{
799 		g_nullify_pointer(nullifyLocation);
800 	}
801 
802 	/**
803 	 * Parses a string containing debugging options
804 	 * into a %guint containing bit flags. This is used
805 	 * within GDK and GTK+ to parse the debug options passed on the
806 	 * command line or through environment variables.
807 	 *
808 	 * If @string is equal to "all", all flags are set. Any flags
809 	 * specified along with "all" in @string are inverted; thus,
810 	 * "all,foo,bar" or "foo,bar,all" sets all flags except those
811 	 * corresponding to "foo" and "bar".
812 	 *
813 	 * If @string is equal to "help", all the available keys in @keys
814 	 * are printed out to standard error.
815 	 *
816 	 * Params:
817 	 *     str = a list of debug options separated by colons, spaces, or
818 	 *         commas, or %NULL.
819 	 *     keys = pointer to an array of #GDebugKey which associate
820 	 *         strings with bit flags.
821 	 *     nkeys = the number of #GDebugKeys in the array.
822 	 *
823 	 * Return: the combined set of bit flags.
824 	 */
825 	public static uint parseDebugString(string str, GDebugKey[] keys)
826 	{
827 		return g_parse_debug_string(Str.toStringz(str), keys.ptr, cast(uint)keys.length);
828 	}
829 
830 	/**
831 	 * Gets the last component of the filename.
832 	 *
833 	 * If @file_name ends with a directory separator it gets the component
834 	 * before the last slash. If @file_name consists only of directory
835 	 * separators (and on Windows, possibly a drive letter), a single
836 	 * separator is returned. If @file_name is empty, it gets ".".
837 	 *
838 	 * Params:
839 	 *     fileName = the name of the file
840 	 *
841 	 * Return: a newly allocated string containing the last
842 	 *     component of the filename
843 	 */
844 	public static string pathGetBasename(string fileName)
845 	{
846 		auto retStr = g_path_get_basename(Str.toStringz(fileName));
847 		
848 		scope(exit) Str.freeString(retStr);
849 		return Str.toString(retStr);
850 	}
851 
852 	/**
853 	 * Gets the directory components of a file name.
854 	 *
855 	 * If the file name has no directory components "." is returned.
856 	 * The returned string should be freed when no longer needed.
857 	 *
858 	 * Params:
859 	 *     fileName = the name of the file
860 	 *
861 	 * Return: the directory components of the file
862 	 */
863 	public static string pathGetDirname(string fileName)
864 	{
865 		auto retStr = g_path_get_dirname(Str.toStringz(fileName));
866 		
867 		scope(exit) Str.freeString(retStr);
868 		return Str.toString(retStr);
869 	}
870 
871 	/**
872 	 * Returns %TRUE if the given @file_name is an absolute file name.
873 	 * Note that this is a somewhat vague concept on Windows.
874 	 *
875 	 * On POSIX systems, an absolute file name is well-defined. It always
876 	 * starts from the single root directory. For example "/usr/local".
877 	 *
878 	 * On Windows, the concepts of current drive and drive-specific
879 	 * current directory introduce vagueness. This function interprets as
880 	 * an absolute file name one that either begins with a directory
881 	 * separator such as "\Users\tml" or begins with the root on a drive,
882 	 * for example "C:\Windows". The first case also includes UNC paths
883 	 * such as "\\myserver\docs\foo". In all cases, either slashes or
884 	 * backslashes are accepted.
885 	 *
886 	 * Note that a file name relative to the current drive root does not
887 	 * truly specify a file uniquely over time and across processes, as
888 	 * the current drive is a per-process value and can be changed.
889 	 *
890 	 * File names relative the current directory on some specific drive,
891 	 * such as "D:foo/bar", are not interpreted as absolute by this
892 	 * function, but they obviously are not relative to the normal current
893 	 * directory as returned by getcwd() or g_get_current_dir()
894 	 * either. Such paths should be avoided, or need to be handled using
895 	 * Windows-specific code.
896 	 *
897 	 * Params:
898 	 *     fileName = a file name
899 	 *
900 	 * Return: %TRUE if @file_name is absolute
901 	 */
902 	public static bool pathIsAbsolute(string fileName)
903 	{
904 		return g_path_is_absolute(Str.toStringz(fileName)) != 0;
905 	}
906 
907 	/**
908 	 * Returns a pointer into @file_name after the root component,
909 	 * i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name
910 	 * is not an absolute path it returns %NULL.
911 	 *
912 	 * Params:
913 	 *     fileName = a file name
914 	 *
915 	 * Return: a pointer into @file_name after the root component
916 	 */
917 	public static string pathSkipRoot(string fileName)
918 	{
919 		return Str.toString(g_path_skip_root(Str.toStringz(fileName)));
920 	}
921 
922 	/**
923 	 * This is just like the standard C qsort() function, but
924 	 * the comparison routine accepts a user data argument.
925 	 *
926 	 * This is guaranteed to be a stable sort since version 2.32.
927 	 *
928 	 * Params:
929 	 *     pbase = start of array to sort
930 	 *     totalElems = elements in the array
931 	 *     size = size of each element
932 	 *     compareFunc = function to compare elements
933 	 *     userData = data to pass to @compare_func
934 	 */
935 	public static void qsortWithData(void* pbase, int totalElems, size_t size, GCompareDataFunc compareFunc, void* userData)
936 	{
937 		g_qsort_with_data(pbase, totalElems, size, compareFunc, userData);
938 	}
939 
940 	/**
941 	 * Resets the cache used for g_get_user_special_dir(), so
942 	 * that the latest on-disk version is used. Call this only
943 	 * if you just changed the data on disk yourself.
944 	 *
945 	 * Due to threadsafety issues this may cause leaking of strings
946 	 * that were previously returned from g_get_user_special_dir()
947 	 * that can't be freed. We ensure to only leak the data for
948 	 * the directories that actually changed value though.
949 	 *
950 	 * Since: 2.22
951 	 */
952 	public static void reloadUserSpecialDirsCache()
953 	{
954 		g_reload_user_special_dirs_cache();
955 	}
956 
957 	/**
958 	 * Sets a human-readable name for the application. This name should be
959 	 * localized if possible, and is intended for display to the user.
960 	 * Contrast with g_set_prgname(), which sets a non-localized name.
961 	 * g_set_prgname() will be called automatically by gtk_init(),
962 	 * but g_set_application_name() will not.
963 	 *
964 	 * Note that for thread safety reasons, this function can only
965 	 * be called once.
966 	 *
967 	 * The application name will be used in contexts such as error messages,
968 	 * or when displaying an application's name in the task list.
969 	 *
970 	 * Params:
971 	 *     applicationName = localized name of the application
972 	 *
973 	 * Since: 2.2
974 	 */
975 	public static void setApplicationName(string applicationName)
976 	{
977 		g_set_application_name(Str.toStringz(applicationName));
978 	}
979 
980 	/**
981 	 * Sets the name of the program. This name should not be localized,
982 	 * in contrast to g_set_application_name().
983 	 *
984 	 * Note that for thread-safety reasons this function can only be called once.
985 	 *
986 	 * Params:
987 	 *     prgname = the name of the program.
988 	 */
989 	public static void setPrgname(string prgname)
990 	{
991 		g_set_prgname(Str.toStringz(prgname));
992 	}
993 
994 	/**
995 	 * Sets an environment variable. On UNIX, both the variable's name and
996 	 * value can be arbitrary byte strings, except that the variable's name
997 	 * cannot contain '='. On Windows, they should be in UTF-8.
998 	 *
999 	 * Note that on some systems, when variables are overwritten, the memory
1000 	 * used for the previous variables and its value isn't reclaimed.
1001 	 *
1002 	 * You should be mindful of the fact that environment variable handling
1003 	 * in UNIX is not thread-safe, and your program may crash if one thread
1004 	 * calls g_setenv() while another thread is calling getenv(). (And note
1005 	 * that many functions, such as gettext(), call getenv() internally.)
1006 	 * This function is only safe to use at the very start of your program,
1007 	 * before creating any other threads (or creating objects that create
1008 	 * worker threads of their own).
1009 	 *
1010 	 * If you need to set up the environment for a child process, you can
1011 	 * use g_get_environ() to get an environment array, modify that with
1012 	 * g_environ_setenv() and g_environ_unsetenv(), and then pass that
1013 	 * array directly to execvpe(), g_spawn_async(), or the like.
1014 	 *
1015 	 * Params:
1016 	 *     variable = the environment variable to set, must not contain '='.
1017 	 *     value = the value for to set the variable to.
1018 	 *     overwrite = whether to change the variable if it already exists.
1019 	 *
1020 	 * Return: %FALSE if the environment variable couldn't be set.
1021 	 *
1022 	 * Since: 2.4
1023 	 */
1024 	public static bool setenv(string variable, string value, bool overwrite)
1025 	{
1026 		return g_setenv(Str.toStringz(variable), Str.toStringz(value), overwrite) != 0;
1027 	}
1028 
1029 	/**
1030 	 * Gets the smallest prime number from a built-in array of primes which
1031 	 * is larger than @num. This is used within GLib to calculate the optimum
1032 	 * size of a #GHashTable.
1033 	 *
1034 	 * The built-in array of primes ranges from 11 to 13845163 such that
1035 	 * each prime is approximately 1.5-2 times the previous prime.
1036 	 *
1037 	 * Params:
1038 	 *     num = a #guint
1039 	 *
1040 	 * Return: the smallest prime number from a built-in array of primes
1041 	 *     which is larger than @num
1042 	 */
1043 	public static uint spacedPrimesClosest(uint num)
1044 	{
1045 		return g_spaced_primes_closest(num);
1046 	}
1047 
1048 	/**
1049 	 * Removes an environment variable from the environment.
1050 	 *
1051 	 * Note that on some systems, when variables are overwritten, the
1052 	 * memory used for the previous variables and its value isn't reclaimed.
1053 	 *
1054 	 * You should be mindful of the fact that environment variable handling
1055 	 * in UNIX is not thread-safe, and your program may crash if one thread
1056 	 * calls g_unsetenv() while another thread is calling getenv(). (And note
1057 	 * that many functions, such as gettext(), call getenv() internally.) This
1058 	 * function is only safe to use at the very start of your program, before
1059 	 * creating any other threads (or creating objects that create worker
1060 	 * threads of their own).
1061 	 *
1062 	 * If you need to set up the environment for a child process, you can
1063 	 * use g_get_environ() to get an environment array, modify that with
1064 	 * g_environ_setenv() and g_environ_unsetenv(), and then pass that
1065 	 * array directly to execvpe(), g_spawn_async(), or the like.
1066 	 *
1067 	 * Params:
1068 	 *     variable = the environment variable to remove, must not contain '='
1069 	 *
1070 	 * Since: 2.4
1071 	 */
1072 	public static void unsetenv(string variable)
1073 	{
1074 		g_unsetenv(Str.toStringz(variable));
1075 	}
1076 }