* This library 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 2 of the License, or (at your option) any later version.
+ * version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
/*
#include "config.h"
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
+#include "gutils.h"
+#include "gutilsprivate.h"
+
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
-#ifdef HAVE_PWD_H
+#ifdef G_OS_UNIX
#include <pwd.h>
+#include <sys/utsname.h>
+#include <unistd.h>
#endif
#include <sys/types.h>
#ifdef HAVE_SYS_PARAM_H
#ifdef HAVE_CRT_EXTERNS_H
#include <crt_externs.h> /* for _NSGetEnviron */
#endif
-
-/* implement gutils's inline functions
- */
-#define G_IMPLEMENT_INLINES 1
-#define __G_UTILS_C__
-#include "gutils.h"
+#ifdef HAVE_SYS_AUXV_H
+#include <sys/auxv.h>
+#endif
#include "glib-init.h"
+#include "glib-private.h"
#include "genviron.h"
#include "gfileutils.h"
+#include "ggettext.h"
#include "ghash.h"
-#include "gslist.h"
-#include "gprintfint.h"
#include "gthread.h"
-#include "gthreadprivate.h"
#include "gtestutils.h"
#include "gunicode.h"
#include "gstrfuncs.h"
#include "garray.h"
#include "glibintl.h"
+#include "gstdio.h"
#ifdef G_PLATFORM_WIN32
-#include "garray.h"
#include "gconvert.h"
#include "gwin32.h"
#endif
* These are portable utility functions.
*/
-#ifdef MAXPATHLEN
-#define G_PATH_LENGTH MAXPATHLEN
-#elif defined (PATH_MAX)
-#define G_PATH_LENGTH PATH_MAX
-#elif defined (_PC_PATH_MAX)
-#define G_PATH_LENGTH sysconf(_PC_PATH_MAX)
-#else
-#define G_PATH_LENGTH 2048
-#endif
-
#ifdef G_PLATFORM_WIN32
# include <windows.h>
# ifndef GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
#ifdef G_OS_WIN32
# include <direct.h>
# include <shlobj.h>
- /* older SDK (e.g. msvc 5.0) does not have these*/
-# ifndef CSIDL_MYMUSIC
-# define CSIDL_MYMUSIC 13
-# endif
-# ifndef CSIDL_MYVIDEO
-# define CSIDL_MYVIDEO 14
-# endif
-# ifndef CSIDL_INTERNET_CACHE
-# define CSIDL_INTERNET_CACHE 32
-# endif
-# ifndef CSIDL_COMMON_APPDATA
-# define CSIDL_COMMON_APPDATA 35
-# endif
-# ifndef CSIDL_MYPICTURES
-# define CSIDL_MYPICTURES 0x27
-# endif
-# ifndef CSIDL_COMMON_DOCUMENTS
-# define CSIDL_COMMON_DOCUMENTS 46
-# endif
-# ifndef CSIDL_PROFILE
-# define CSIDL_PROFILE 40
-# endif
# include <process.h>
#endif
-#ifdef HAVE_CARBON
-#include <CoreServices/CoreServices.h>
-#endif
-
#ifdef HAVE_CODESET
#include <langinfo.h>
#endif
#endif
-#if !defined (HAVE_MEMMOVE) && !defined (HAVE_WORKING_BCOPY)
/**
* g_memmove:
* @dest: the destination address to copy the bytes to.
* Copies a block of memory @len bytes long, from @src to @dest.
* The source and destination areas may overlap.
*
- * In order to use this function, you must include
- * <filename>string.h</filename> yourself, because this macro will
- * typically simply resolve to memmove() and GLib does not include
- * <filename>string.h</filename> for you.
+ * Deprecated:2.40: Just use memmove().
*/
-void
-g_memmove (gpointer dest,
- gconstpointer src,
- gulong len)
-{
- gchar* destptr = dest;
- const gchar* srcptr = src;
- if (src + len < dest || dest + len < src)
- {
- bcopy (src, dest, len);
- return;
- }
- else if (dest <= src)
- {
- while (len--)
- *(destptr++) = *(srcptr++);
- }
- else
- {
- destptr += len;
- srcptr += len;
- while (len--)
- *(--destptr) = *(--srcptr);
- }
-}
-#endif /* !HAVE_MEMMOVE && !HAVE_WORKING_BCOPY */
#ifdef G_OS_WIN32
#undef g_atexit
* As can be seen from the above, for portability it's best to avoid
* calling g_atexit() (or atexit()) except in the main executable of a
* program.
+ *
+ * Deprecated:2.32: It is best to avoid g_atexit().
*/
+G_GNUC_BEGIN_IGNORE_DEPRECATIONS
void
g_atexit (GVoidFunc func)
{
gint result;
- const gchar *error = NULL;
+ int errsv;
- /* keep this in sync with glib.h */
-
-#ifdef G_NATIVE_ATEXIT
- result = ATEXIT (func);
- if (result)
- error = g_strerror (errno);
-#elif defined (HAVE_ATEXIT)
-# ifdef NeXT /* @#%@! NeXTStep */
- result = !atexit ((void (*)(void)) func);
- if (result)
- error = g_strerror (errno);
-# else
result = atexit ((void (*)(void)) func);
+ errsv = errno;
if (result)
- error = g_strerror (errno);
-# endif /* NeXT */
-#elif defined (HAVE_ON_EXIT)
- result = on_exit ((void (*)(int, void *)) func, NULL);
- if (result)
- error = g_strerror (errno);
-#else
- result = 0;
- error = "no implementation";
-#endif /* G_NATIVE_ATEXIT */
-
- if (error)
- g_error ("Could not register atexit() function: %s", error);
+ {
+ g_error ("Could not register atexit() function: %s",
+ g_strerror (errsv));
+ }
}
+G_GNUC_END_IGNORE_DEPRECATIONS
/* Based on execvp() from GNU Libc.
* Some of this code is cut-and-pasted into gspawn.c
/**
* g_find_program_in_path:
- * @program: a program name in the GLib file name encoding
+ * @program: (type filename): a program name in the GLib file name encoding
*
* Locates the first executable named @program in the user's path, in the
* same way that execvp() would locate it. Returns an allocated string
*
* On Windows, if @program does not have a file type suffix, tries
* with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
- * the <envar>PATHEXT</envar> environment variable.
+ * the `PATHEXT` environment variable.
*
* On Windows, it looks for the file in the same way as CreateProcess()
* would. This means first in the directory where the executing
* program was loaded from, then in the current directory, then in the
* Windows 32-bit system directory, then in the Windows directory, and
- * finally in the directories in the <envar>PATH</envar> environment
- * variable. If the program is found, the return value contains the
- * full name including the type suffix.
+ * finally in the directories in the `PATH` environment variable. If
+ * the program is found, the return value contains the full name
+ * including the type suffix.
*
- * Return value: absolute path, or %NULL
+ * Returns: (type filename) (transfer full) (nullable): a newly-allocated
+ * string with the absolute path, or %NULL
**/
#ifdef G_OS_WIN32
static gchar *
}
path = g_getenv ("PATH");
-#if defined(G_OS_UNIX) || defined(G_OS_BEOS)
+#if defined(G_OS_UNIX)
if (path == NULL)
{
- /* There is no `PATH' in the environment. The default
+ /* There is no 'PATH' in the environment. The default
* search path in GNU libc is the current directory followed by
- * the path `confstr' returns for `_CS_PATH'.
+ * the path 'confstr' returns for '_CS_PATH'.
*/
/* In GLib we put . last, for security, and don't use the
if (p == path)
/* Two adjacent colons, or a colon at the beginning or the end
- * of `PATH' means to search the current directory.
+ * of 'PATH' means to search the current directory.
*/
startp = name + 1;
else
return NULL;
}
-/**
- * g_basename:
- * @file_name: the name of the file.
- *
- * Gets the name of the file without any leading directory components.
- * It returns a pointer into the given file name string.
- *
- * Return value: the name of the file without any leading directory components.
- *
- * Deprecated:2.2: Use g_path_get_basename() instead, but notice that
- * g_path_get_basename() allocates new memory for the returned string, unlike
- * this function which returns a pointer into the argument.
- **/
-const gchar *
-g_basename (const gchar *file_name)
-{
- register gchar *base;
-
- g_return_val_if_fail (file_name != NULL, NULL);
-
- base = strrchr (file_name, G_DIR_SEPARATOR);
-
-#ifdef G_OS_WIN32
- {
- gchar *q = strrchr (file_name, '/');
- if (base == NULL || (q != NULL && q > base))
- base = q;
- }
-#endif
-
- if (base)
- return base + 1;
-
-#ifdef G_OS_WIN32
- if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
- return (gchar*) file_name + 2;
-#endif /* G_OS_WIN32 */
-
- return (gchar*) file_name;
-}
-
-/**
- * g_path_get_basename:
- * @file_name: the name of the file.
- *
- * Gets the last component of the filename. If @file_name ends with a
- * directory separator it gets the component before the last slash. If
- * @file_name consists only of directory separators (and on Windows,
- * possibly a drive letter), a single separator is returned. If
- * @file_name is empty, it gets ".".
- *
- * Return value: a newly allocated string containing the last component of
- * the filename.
- */
-gchar*
-g_path_get_basename (const gchar *file_name)
-{
- register gssize base;
- register gssize last_nonslash;
- gsize len;
- gchar *retval;
-
- g_return_val_if_fail (file_name != NULL, NULL);
-
- if (file_name[0] == '\0')
- /* empty string */
- return g_strdup (".");
-
- last_nonslash = strlen (file_name) - 1;
-
- while (last_nonslash >= 0 && G_IS_DIR_SEPARATOR (file_name [last_nonslash]))
- last_nonslash--;
-
- if (last_nonslash == -1)
- /* string only containing slashes */
- return g_strdup (G_DIR_SEPARATOR_S);
-
-#ifdef G_OS_WIN32
- if (last_nonslash == 1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
- /* string only containing slashes and a drive */
- return g_strdup (G_DIR_SEPARATOR_S);
-#endif /* G_OS_WIN32 */
-
- base = last_nonslash;
-
- while (base >=0 && !G_IS_DIR_SEPARATOR (file_name [base]))
- base--;
-
-#ifdef G_OS_WIN32
- if (base == -1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
- base = 1;
-#endif /* G_OS_WIN32 */
-
- len = last_nonslash - base;
- retval = g_malloc (len + 1);
- memcpy (retval, file_name + base + 1, len);
- retval [len] = '\0';
- return retval;
-}
-
-/**
- * g_path_is_absolute:
- * @file_name: a file name.
- *
- * Returns %TRUE if the given @file_name is an absolute file name.
- * Note that this is a somewhat vague concept on Windows.
- *
- * On POSIX systems, an absolute file name is well-defined. It always
- * starts from the single root directory. For example "/usr/local".
- *
- * On Windows, the concepts of current drive and drive-specific
- * current directory introduce vagueness. This function interprets as
- * an absolute file name one that either begins with a directory
- * separator such as "\Users\tml" or begins with the root on a drive,
- * for example "C:\Windows". The first case also includes UNC paths
- * such as "\\myserver\docs\foo". In all cases, either slashes or
- * backslashes are accepted.
- *
- * Note that a file name relative to the current drive root does not
- * truly specify a file uniquely over time and across processes, as
- * the current drive is a per-process value and can be changed.
- *
- * File names relative the current directory on some specific drive,
- * such as "D:foo/bar", are not interpreted as absolute by this
- * function, but they obviously are not relative to the normal current
- * directory as returned by getcwd() or g_get_current_dir()
- * either. Such paths should be avoided, or need to be handled using
- * Windows-specific code.
- *
- * Returns: %TRUE if @file_name is absolute.
- */
-gboolean
-g_path_is_absolute (const gchar *file_name)
-{
- g_return_val_if_fail (file_name != NULL, FALSE);
-
- if (G_IS_DIR_SEPARATOR (file_name[0]))
- return TRUE;
-
-#ifdef G_OS_WIN32
- /* Recognize drive letter on native Windows */
- if (g_ascii_isalpha (file_name[0]) &&
- file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
- return TRUE;
-#endif /* G_OS_WIN32 */
-
- return FALSE;
-}
-
-/**
- * g_path_skip_root:
- * @file_name: a file name.
- *
- * Returns a pointer into @file_name after the root component, i.e. after
- * the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute
- * path it returns %NULL.
- *
- * Returns: a pointer into @file_name after the root component.
+/* The functions below are defined this way for compatibility reasons.
+ * See the note in gutils.h.
*/
-const gchar *
-g_path_skip_root (const gchar *file_name)
-{
- g_return_val_if_fail (file_name != NULL, NULL);
-
-#ifdef G_PLATFORM_WIN32
- /* Skip \\server\share or //server/share */
- if (G_IS_DIR_SEPARATOR (file_name[0]) &&
- G_IS_DIR_SEPARATOR (file_name[1]) &&
- file_name[2] &&
- !G_IS_DIR_SEPARATOR (file_name[2]))
- {
- gchar *p;
-
- p = strchr (file_name + 2, G_DIR_SEPARATOR);
-#ifdef G_OS_WIN32
- {
- gchar *q = strchr (file_name + 2, '/');
- if (p == NULL || (q != NULL && q < p))
- p = q;
- }
-#endif
- if (p &&
- p > file_name + 2 &&
- p[1])
- {
- file_name = p + 1;
-
- while (file_name[0] && !G_IS_DIR_SEPARATOR (file_name[0]))
- file_name++;
-
- /* Possibly skip a backslash after the share name */
- if (G_IS_DIR_SEPARATOR (file_name[0]))
- file_name++;
-
- return (gchar *)file_name;
- }
- }
-#endif
-
- /* Skip initial slashes */
- if (G_IS_DIR_SEPARATOR (file_name[0]))
- {
- while (G_IS_DIR_SEPARATOR (file_name[0]))
- file_name++;
- return (gchar *)file_name;
- }
-
-#ifdef G_OS_WIN32
- /* Skip X:\ */
- if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
- return (gchar *)file_name + 3;
-#endif
-
- return NULL;
-}
/**
* g_bit_nth_lsf:
* from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
* usually). To start searching from the 0th bit, set @nth_bit to -1.
*
- * Returns: the index of the first bit set which is higher than @nth_bit
+ * Returns: the index of the first bit set which is higher than @nth_bit, or -1
+ * if no higher bits are set
*/
+gint
+(g_bit_nth_lsf) (gulong mask,
+ gint nth_bit)
+{
+ return g_bit_nth_lsf_impl (mask, nth_bit);
+}
/**
* g_bit_nth_msf:
* usually). To start searching from the last bit, set @nth_bit to
* -1 or GLIB_SIZEOF_LONG * 8.
*
- * Returns: the index of the first bit set which is lower than @nth_bit
+ * Returns: the index of the first bit set which is lower than @nth_bit, or -1
+ * if no lower bits are set
*/
+gint
+(g_bit_nth_msf) (gulong mask,
+ gint nth_bit)
+{
+ return g_bit_nth_msf_impl (mask, nth_bit);
+}
+
/**
* g_bit_storage:
*
* Returns: the number of bits used to hold @number
*/
-
-/**
- * g_dirname:
- * @file_name: the name of the file
- *
- * Gets the directory components of a file name.
- * If the file name has no directory components "." is returned.
- * The returned string should be freed when no longer needed.
- *
- * Returns: the directory components of the file
- *
- * Deprecated: use g_path_get_dirname() instead
- */
-
-/**
- * g_path_get_dirname:
- * @file_name: the name of the file.
- *
- * Gets the directory components of a file name. If the file name has no
- * directory components "." is returned. The returned string should be
- * freed when no longer needed.
- *
- * Returns: the directory components of the file.
- */
-gchar*
-g_path_get_dirname (const gchar *file_name)
-{
- register gchar *base;
- register gsize len;
-
- g_return_val_if_fail (file_name != NULL, NULL);
-
- base = strrchr (file_name, G_DIR_SEPARATOR);
-#ifdef G_OS_WIN32
- {
- gchar *q = strrchr (file_name, '/');
- if (base == NULL || (q != NULL && q > base))
- base = q;
- }
-#endif
- if (!base)
- {
-#ifdef G_OS_WIN32
- if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
- {
- gchar drive_colon_dot[4];
-
- drive_colon_dot[0] = file_name[0];
- drive_colon_dot[1] = ':';
- drive_colon_dot[2] = '.';
- drive_colon_dot[3] = '\0';
-
- return g_strdup (drive_colon_dot);
- }
-#endif
- return g_strdup (".");
- }
-
- while (base > file_name && G_IS_DIR_SEPARATOR (*base))
- base--;
-
-#ifdef G_OS_WIN32
- /* base points to the char before the last slash.
- *
- * In case file_name is the root of a drive (X:\) or a child of the
- * root of a drive (X:\foo), include the slash.
- *
- * In case file_name is the root share of an UNC path
- * (\\server\share), add a slash, returning \\server\share\ .
- *
- * In case file_name is a direct child of a share in an UNC path
- * (\\server\share\foo), include the slash after the share name,
- * returning \\server\share\ .
- */
- if (base == file_name + 1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
- base++;
- else if (G_IS_DIR_SEPARATOR (file_name[0]) &&
- G_IS_DIR_SEPARATOR (file_name[1]) &&
- file_name[2] &&
- !G_IS_DIR_SEPARATOR (file_name[2]) &&
- base >= file_name + 2)
- {
- const gchar *p = file_name + 2;
- while (*p && !G_IS_DIR_SEPARATOR (*p))
- p++;
- if (p == base + 1)
- {
- len = (guint) strlen (file_name) + 1;
- base = g_new (gchar, len + 1);
- strcpy (base, file_name);
- base[len-1] = G_DIR_SEPARATOR;
- base[len] = 0;
- return base;
- }
- if (G_IS_DIR_SEPARATOR (*p))
- {
- p++;
- while (*p && !G_IS_DIR_SEPARATOR (*p))
- p++;
- if (p == base + 1)
- base++;
- }
- }
-#endif
-
- len = (guint) 1 + base - file_name;
-
- base = g_new (gchar, len + 1);
- g_memmove (base, file_name, len);
- base[len] = 0;
-
- return base;
-}
-
-/**
- * g_get_current_dir:
- *
- * Gets the current directory.
- * The returned string should be freed when no longer needed. The encoding
- * of the returned string is system defined. On Windows, it is always UTF-8.
- *
- * Returns: the current directory.
- */
-gchar*
-g_get_current_dir (void)
+guint
+(g_bit_storage) (gulong number)
{
-#ifdef G_OS_WIN32
-
- gchar *dir = NULL;
- wchar_t dummy[2], *wdir;
- int len;
-
- len = GetCurrentDirectoryW (2, dummy);
- wdir = g_new (wchar_t, len);
-
- if (GetCurrentDirectoryW (len, wdir) == len - 1)
- dir = g_utf16_to_utf8 (wdir, -1, NULL, NULL, NULL);
-
- g_free (wdir);
-
- if (dir == NULL)
- dir = g_strdup ("\\");
-
- return dir;
-
-#else
-
- gchar *buffer = NULL;
- gchar *dir = NULL;
- static gulong max_len = 0;
-
- if (max_len == 0)
- max_len = (G_PATH_LENGTH == -1) ? 2048 : G_PATH_LENGTH;
-
- /* We don't use getcwd(3) on SUNOS, because, it does a popen("pwd")
- * and, if that wasn't bad enough, hangs in doing so.
- */
-#if (defined (sun) && !defined (__SVR4)) || !defined(HAVE_GETCWD)
- buffer = g_new (gchar, max_len + 1);
- *buffer = 0;
- dir = getwd (buffer);
-#else /* !sun || !HAVE_GETCWD */
- while (max_len < G_MAXULONG / 2)
- {
- g_free (buffer);
- buffer = g_new (gchar, max_len + 1);
- *buffer = 0;
- dir = getcwd (buffer, max_len);
-
- if (dir || errno != ERANGE)
- break;
-
- max_len *= 2;
- }
-#endif /* !sun || !HAVE_GETCWD */
-
- if (!dir || !*buffer)
- {
- /* hm, should we g_error() out here?
- * this can happen if e.g. "./" has mode \0000
- */
- buffer[0] = G_DIR_SEPARATOR;
- buffer[1] = 0;
- }
-
- dir = g_strdup (buffer);
- g_free (buffer);
-
- return dir;
-#endif /* !Win32 */
+ return g_bit_storage_impl (number);
}
G_LOCK_DEFINE_STATIC (g_utils_global);
-static gchar *g_tmp_dir = NULL;
-static gchar *g_user_name = NULL;
-static gchar *g_real_name = NULL;
-static gchar *g_home_dir = NULL;
-static gchar *g_host_name = NULL;
-
-#ifdef G_OS_WIN32
-/* System codepage versions of the above, kept at file level so that they,
- * too, are produced only once.
- */
-static gchar *g_tmp_dir_cp = NULL;
-static gchar *g_user_name_cp = NULL;
-static gchar *g_real_name_cp = NULL;
-static gchar *g_home_dir_cp = NULL;
-#endif
+typedef struct
+{
+ gchar *user_name;
+ gchar *real_name;
+ gchar *home_dir;
+} UserDatabaseEntry;
+/* These must all be read/written with @g_utils_global held. */
static gchar *g_user_data_dir = NULL;
static gchar **g_system_data_dirs = NULL;
static gchar *g_user_cache_dir = NULL;
static gchar *g_user_config_dir = NULL;
+static gchar *g_user_runtime_dir = NULL;
static gchar **g_system_config_dirs = NULL;
-
static gchar **g_user_special_dirs = NULL;
/* fifteen minutes of fame for everybody */
#endif
/* HOLDS: g_utils_global_lock */
-static void
-g_get_any_init_do (void)
+static UserDatabaseEntry *
+g_get_user_database_entry (void)
{
- gchar hostname[100];
+ static UserDatabaseEntry *entry;
- g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
- if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
- g_tmp_dir = g_strdup (g_getenv ("TMP"));
- if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
- g_tmp_dir = g_strdup (g_getenv ("TEMP"));
-
-#ifdef G_OS_WIN32
- if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
- g_tmp_dir = get_windows_directory_root ();
-#else
-#ifdef P_tmpdir
- if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
+ if (g_once_init_enter (&entry))
{
- gsize k;
- g_tmp_dir = g_strdup (P_tmpdir);
- k = strlen (g_tmp_dir);
- if (k > 1 && G_IS_DIR_SEPARATOR (g_tmp_dir[k - 1]))
- g_tmp_dir[k - 1] = '\0';
- }
+ static UserDatabaseEntry e;
+
+#ifdef G_OS_UNIX
+ {
+ struct passwd *pw = NULL;
+ gpointer buffer = NULL;
+ gint error;
+ gchar *logname;
+
+# if defined (HAVE_GETPWUID_R)
+ struct passwd pwd;
+# ifdef _SC_GETPW_R_SIZE_MAX
+ /* This reurns the maximum length */
+ glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
+
+ if (bufsize < 0)
+ bufsize = 64;
+# else /* _SC_GETPW_R_SIZE_MAX */
+ glong bufsize = 64;
+# endif /* _SC_GETPW_R_SIZE_MAX */
+
+ logname = (gchar *) g_getenv ("LOGNAME");
+
+ do
+ {
+ g_free (buffer);
+ /* we allocate 6 extra bytes to work around a bug in
+ * Mac OS < 10.3. See #156446
+ */
+ buffer = g_malloc (bufsize + 6);
+ errno = 0;
+
+ if (logname) {
+ error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
+ if (!pw || (pw->pw_uid != getuid ())) {
+ /* LOGNAME is lying, fall back to looking up the uid */
+ error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
+ }
+ } else {
+ error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
+ }
+ error = error < 0 ? errno : error;
+
+ if (!pw)
+ {
+ /* we bail out prematurely if the user id can't be found
+ * (should be pretty rare case actually), or if the buffer
+ * should be sufficiently big and lookups are still not
+ * successful.
+ */
+ if (error == 0 || error == ENOENT)
+ {
+ g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
+ (gulong) getuid ());
+ break;
+ }
+ if (bufsize > 32 * 1024)
+ {
+ g_warning ("getpwuid_r(): failed due to: %s.",
+ g_strerror (error));
+ break;
+ }
+
+ bufsize *= 2;
+ }
+ }
+ while (!pw);
+# endif /* HAVE_GETPWUID_R */
+
+ if (!pw)
+ {
+ pw = getpwuid (getuid ());
+ }
+ if (pw)
+ {
+ e.user_name = g_strdup (pw->pw_name);
+
+#ifndef __BIONIC__
+ if (pw->pw_gecos && *pw->pw_gecos != '\0' && pw->pw_name)
+ {
+ gchar **gecos_fields;
+ gchar **name_parts;
+
+ /* split the gecos field and substitute '&' */
+ gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
+ name_parts = g_strsplit (gecos_fields[0], "&", 0);
+ pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
+ e.real_name = g_strjoinv (pw->pw_name, name_parts);
+ g_strfreev (gecos_fields);
+ g_strfreev (name_parts);
+ }
#endif
-
- if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
- {
- g_tmp_dir = g_strdup ("/tmp");
- }
-#endif /* !G_OS_WIN32 */
-
+
+ if (!e.home_dir)
+ e.home_dir = g_strdup (pw->pw_dir);
+ }
+ g_free (buffer);
+ }
+
+#endif /* G_OS_UNIX */
+
#ifdef G_OS_WIN32
- /* We check $HOME first for Win32, though it is a last resort for Unix
- * where we prefer the results of getpwuid().
- */
- g_home_dir = g_strdup (g_getenv ("HOME"));
+ {
+ guint len = UNLEN+1;
+ wchar_t buffer[UNLEN+1];
+
+ if (GetUserNameW (buffer, (LPDWORD) &len))
+ {
+ e.user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
+ e.real_name = g_strdup (e.user_name);
+ }
+ }
+#endif /* G_OS_WIN32 */
- /* Only believe HOME if it is an absolute path and exists */
- if (g_home_dir)
- {
- if (!(g_path_is_absolute (g_home_dir) &&
- g_file_test (g_home_dir, G_FILE_TEST_IS_DIR)))
- {
- g_free (g_home_dir);
- g_home_dir = NULL;
- }
- }
-
- /* In case HOME is Unix-style (it happens), convert it to
- * Windows style.
- */
- if (g_home_dir)
- {
- gchar *p;
- while ((p = strchr (g_home_dir, '/')) != NULL)
- *p = '\\';
- }
+ if (!e.user_name)
+ e.user_name = g_strdup ("somebody");
+ if (!e.real_name)
+ e.real_name = g_strdup ("Unknown");
- if (!g_home_dir)
- {
- /* USERPROFILE is probably the closest equivalent to $HOME? */
- if (g_getenv ("USERPROFILE") != NULL)
- g_home_dir = g_strdup (g_getenv ("USERPROFILE"));
+ g_once_init_leave (&entry, &e);
}
- if (!g_home_dir)
- g_home_dir = get_special_folder (CSIDL_PROFILE);
-
- if (!g_home_dir)
- g_home_dir = get_windows_directory_root ();
-#endif /* G_OS_WIN32 */
-
-#ifdef HAVE_PWD_H
- {
- struct passwd *pw = NULL;
- gpointer buffer = NULL;
- gint error;
- gchar *logname;
-
-# if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
- struct passwd pwd;
-# ifdef _SC_GETPW_R_SIZE_MAX
- /* This reurns the maximum length */
- glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
-
- if (bufsize < 0)
- bufsize = 64;
-# else /* _SC_GETPW_R_SIZE_MAX */
- glong bufsize = 64;
-# endif /* _SC_GETPW_R_SIZE_MAX */
-
- logname = (gchar *) g_getenv ("LOGNAME");
-
- do
- {
- g_free (buffer);
- /* we allocate 6 extra bytes to work around a bug in
- * Mac OS < 10.3. See #156446
- */
- buffer = g_malloc (bufsize + 6);
- errno = 0;
-
-# ifdef HAVE_POSIX_GETPWUID_R
- if (logname) {
- error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
- if (!pw || (pw->pw_uid != getuid ())) {
- /* LOGNAME is lying, fall back to looking up the uid */
- error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
- }
- } else {
- error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
- }
- error = error < 0 ? errno : error;
-# else /* HAVE_NONPOSIX_GETPWUID_R */
- /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
-# if defined(_AIX) || defined(__hpux)
- error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
- pw = error == 0 ? &pwd : NULL;
-# else /* !_AIX */
- if (logname) {
- pw = getpwnam_r (logname, &pwd, buffer, bufsize);
- if (!pw || (pw->pw_uid != getuid ())) {
- /* LOGNAME is lying, fall back to looking up the uid */
- pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
- }
- } else {
- pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
- }
- error = pw ? 0 : errno;
-# endif /* !_AIX */
-# endif /* HAVE_NONPOSIX_GETPWUID_R */
-
- if (!pw)
- {
- /* we bail out prematurely if the user id can't be found
- * (should be pretty rare case actually), or if the buffer
- * should be sufficiently big and lookups are still not
- * successful.
- */
- if (error == 0 || error == ENOENT)
- {
- g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
- (gulong) getuid ());
- break;
- }
- if (bufsize > 32 * 1024)
- {
- g_warning ("getpwuid_r(): failed due to: %s.",
- g_strerror (error));
- break;
- }
-
- bufsize *= 2;
- }
- }
- while (!pw);
-# endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
-
- if (!pw)
- {
- setpwent ();
- pw = getpwuid (getuid ());
- endpwent ();
- }
- if (pw)
- {
- g_user_name = g_strdup (pw->pw_name);
-
- if (pw->pw_gecos && *pw->pw_gecos != '\0')
- {
- gchar **gecos_fields;
- gchar **name_parts;
-
- /* split the gecos field and substitute '&' */
- gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
- name_parts = g_strsplit (gecos_fields[0], "&", 0);
- pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
- g_real_name = g_strjoinv (pw->pw_name, name_parts);
- g_strfreev (gecos_fields);
- g_strfreev (name_parts);
- }
-
- if (!g_home_dir)
- g_home_dir = g_strdup (pw->pw_dir);
- }
- g_free (buffer);
- }
-
-#else /* !HAVE_PWD_H */
-
-#ifdef G_OS_WIN32
- {
- guint len = UNLEN+1;
- wchar_t buffer[UNLEN+1];
-
- if (GetUserNameW (buffer, (LPDWORD) &len))
- {
- g_user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
- g_real_name = g_strdup (g_user_name);
- }
- }
-#endif /* G_OS_WIN32 */
-
-#endif /* !HAVE_PWD_H */
-
-#ifndef G_OS_WIN32
- if (!g_home_dir)
- g_home_dir = g_strdup (g_getenv ("HOME"));
-#endif
-
-#ifdef __EMX__
- /* change '\\' in %HOME% to '/' */
- g_strdelimit (g_home_dir, "\\",'/');
-#endif
- if (!g_user_name)
- g_user_name = g_strdup ("somebody");
- if (!g_real_name)
- g_real_name = g_strdup ("Unknown");
-
- {
-#ifndef G_OS_WIN32
- gboolean hostname_fail = (gethostname (hostname, sizeof (hostname)) == -1);
-#else
- DWORD size = sizeof (hostname);
- gboolean hostname_fail = (!GetComputerName (hostname, &size));
-#endif
- g_host_name = g_strdup (hostname_fail ? "localhost" : hostname);
- }
-
-#ifdef G_OS_WIN32
- g_tmp_dir_cp = g_locale_from_utf8 (g_tmp_dir, -1, NULL, NULL, NULL);
- g_user_name_cp = g_locale_from_utf8 (g_user_name, -1, NULL, NULL, NULL);
- g_real_name_cp = g_locale_from_utf8 (g_real_name, -1, NULL, NULL, NULL);
-
- if (!g_tmp_dir_cp)
- g_tmp_dir_cp = g_strdup ("\\");
- if (!g_user_name_cp)
- g_user_name_cp = g_strdup ("somebody");
- if (!g_real_name_cp)
- g_real_name_cp = g_strdup ("Unknown");
-
- /* home_dir might be NULL, unlike tmp_dir, user_name and
- * real_name.
- */
- if (g_home_dir)
- g_home_dir_cp = g_locale_from_utf8 (g_home_dir, -1, NULL, NULL, NULL);
- else
- g_home_dir_cp = NULL;
-#endif /* G_OS_WIN32 */
-}
-
-static inline void
-g_get_any_init (void)
-{
- if (!g_tmp_dir)
- g_get_any_init_do ();
-}
-
-static inline void
-g_get_any_init_locked (void)
-{
- G_LOCK (g_utils_global);
- g_get_any_init ();
- G_UNLOCK (g_utils_global);
-}
-
+ return entry;
+}
/**
* g_get_user_name:
* encoding, or something else, and there is no guarantee that it is even
* consistent on a machine. On Windows, it is always UTF-8.
*
- * Returns: the user name of the current user.
+ * Returns: (type filename) (transfer none): the user name of the current user.
*/
const gchar *
g_get_user_name (void)
{
- g_get_any_init_locked ();
- return g_user_name;
+ UserDatabaseEntry *entry;
+
+ entry = g_get_user_database_entry ();
+
+ return entry->user_name;
}
/**
* g_get_real_name:
*
- * Gets the real name of the user. This usually comes from the user's entry
- * in the <filename>passwd</filename> file. The encoding of the returned
- * string is system-defined. (On Windows, it is, however, always UTF-8.)
- * If the real user name cannot be determined, the string "Unknown" is
+ * Gets the real name of the user. This usually comes from the user's
+ * entry in the `passwd` file. The encoding of the returned string is
+ * system-defined. (On Windows, it is, however, always UTF-8.) If the
+ * real user name cannot be determined, the string "Unknown" is
* returned.
*
- * Returns: the user's real name.
+ * Returns: (type filename) (transfer none): the user's real name.
*/
const gchar *
g_get_real_name (void)
{
- g_get_any_init_locked ();
- return g_real_name;
+ UserDatabaseEntry *entry;
+
+ entry = g_get_user_database_entry ();
+
+ return entry->real_name;
+}
+
+/* Protected by @g_utils_global_lock. */
+static gchar *g_home_dir = NULL; /* (owned) (nullable before initialised) */
+
+static gchar *
+g_build_home_dir (void)
+{
+ gchar *home_dir;
+
+ /* We first check HOME and use it if it is set */
+ home_dir = g_strdup (g_getenv ("HOME"));
+
+#ifdef G_OS_WIN32
+ /* Only believe HOME if it is an absolute path and exists.
+ *
+ * We only do this check on Windows for a couple of reasons.
+ * Historically, we only did it there because we used to ignore $HOME
+ * on UNIX. There are concerns about enabling it now on UNIX because
+ * of things like autofs. In short, if the user has a bogus value in
+ * $HOME then they get what they pay for...
+ */
+ if (home_dir != NULL)
+ {
+ if (!(g_path_is_absolute (home_dir) &&
+ g_file_test (home_dir, G_FILE_TEST_IS_DIR)))
+ g_clear_pointer (&home_dir, g_free);
+ }
+
+ /* In case HOME is Unix-style (it happens), convert it to
+ * Windows style.
+ */
+ if (home_dir != NULL)
+ {
+ gchar *p;
+ while ((p = strchr (home_dir, '/')) != NULL)
+ *p = '\\';
+ }
+
+ if (home_dir == NULL)
+ {
+ /* USERPROFILE is probably the closest equivalent to $HOME? */
+ if (g_getenv ("USERPROFILE") != NULL)
+ home_dir = g_strdup (g_getenv ("USERPROFILE"));
+ }
+
+ if (home_dir == NULL)
+ home_dir = get_special_folder (CSIDL_PROFILE);
+
+ if (home_dir == NULL)
+ home_dir = get_windows_directory_root ();
+#endif /* G_OS_WIN32 */
+
+ if (home_dir == NULL)
+ {
+ /* If we didn't get it from any of those methods, we will have
+ * to read the user database entry.
+ */
+ UserDatabaseEntry *entry = g_get_user_database_entry ();
+ home_dir = g_strdup (entry->home_dir);
+ }
+
+ /* If we have been denied access to /etc/passwd (for example, by an
+ * overly-zealous LSM), make up a junk value. The return value at this
+ * point is explicitly documented as ‘undefined’. */
+ if (home_dir == NULL)
+ {
+ g_warning ("Could not find home directory: $HOME is not set, and "
+ "user database could not be read.");
+ home_dir = g_strdup ("/");
+ }
+
+ return g_steal_pointer (&home_dir);
}
/**
* g_get_home_dir:
*
- * Gets the current user's home directory as defined in the
- * password database.
- *
- * Note that in contrast to traditional UNIX tools, this function
- * prefers <filename>passwd</filename> entries over the <envar>HOME</envar>
- * environment variable.
- *
- * One of the reasons for this decision is that applications in many
- * cases need special handling to deal with the case where
- * <envar>HOME</envar> is
- * <simplelist>
- * <member>Not owned by the user</member>
- * <member>Not writeable</member>
- * <member>Not even readable</member>
- * </simplelist>
- * Since applications are in general <emphasis>not</emphasis> written
- * to deal with these situations it was considered better to make
- * g_get_home_dir() not pay attention to <envar>HOME</envar> and to
- * return the real home directory for the user. If applications
- * want to pay attention to <envar>HOME</envar>, they can do:
- * |[
- * const char *homedir = g_getenv ("HOME");
- * if (!homedir)
- * homedir = g_get_home_dir (<!-- -->);
- * ]|
- *
- * Returns: the current user's home directory
+ * Gets the current user's home directory.
+ *
+ * As with most UNIX tools, this function will return the value of the
+ * `HOME` environment variable if it is set to an existing absolute path
+ * name, falling back to the `passwd` file in the case that it is unset.
+ *
+ * If the path given in `HOME` is non-absolute, does not exist, or is
+ * not a directory, the result is undefined.
+ *
+ * Before version 2.36 this function would ignore the `HOME` environment
+ * variable, taking the value from the `passwd` database instead. This was
+ * changed to increase the compatibility of GLib with other programs (and
+ * the XDG basedir specification) and to increase testability of programs
+ * based on GLib (by making it easier to run them from test frameworks).
+ *
+ * If your program has a strong requirement for either the new or the
+ * old behaviour (and if you don't wish to increase your GLib
+ * dependency to ensure that the new behaviour is in effect) then you
+ * should either directly check the `HOME` environment variable yourself
+ * or unset it before calling any functions in GLib.
+ *
+ * Returns: (type filename) (transfer none): the current user's home directory
*/
const gchar *
g_get_home_dir (void)
{
- g_get_any_init_locked ();
- return g_home_dir;
+ const gchar *home_dir;
+
+ G_LOCK (g_utils_global);
+
+ if (g_home_dir == NULL)
+ g_home_dir = g_build_home_dir ();
+ home_dir = g_home_dir;
+
+ G_UNLOCK (g_utils_global);
+
+ return home_dir;
}
/**
* g_get_tmp_dir:
*
- * Gets the directory to use for temporary files. This is found from
- * inspecting the environment variables <envar>TMPDIR</envar>,
- * <envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none
- * of those are defined "/tmp" is returned on UNIX and "C:\" on Windows.
- * The encoding of the returned string is system-defined. On Windows,
- * it is always UTF-8. The return value is never %NULL or the empty string.
+ * Gets the directory to use for temporary files.
+ *
+ * On UNIX, this is taken from the `TMPDIR` environment variable.
+ * If the variable is not set, `P_tmpdir` is
+ * used, as defined by the system C library. Failing that, a
+ * hard-coded default of "/tmp" is returned.
*
- * Returns: the directory to use for temporary files.
+ * On Windows, the `TEMP` environment variable is used, with the
+ * root directory of the Windows installation (eg: "C:\") used
+ * as a default.
+ *
+ * The encoding of the returned string is system-defined. On Windows,
+ * it is always UTF-8. The return value is never %NULL or the empty
+ * string.
+ *
+ * Returns: (type filename) (transfer none): the directory to use for temporary files.
*/
const gchar *
g_get_tmp_dir (void)
{
- g_get_any_init_locked ();
- return g_tmp_dir;
+ static gchar *tmp_dir;
+
+ if (g_once_init_enter (&tmp_dir))
+ {
+ gchar *tmp;
+
+#ifdef G_OS_WIN32
+ tmp = g_strdup (g_getenv ("TEMP"));
+
+ if (tmp == NULL || *tmp == '\0')
+ {
+ g_free (tmp);
+ tmp = get_windows_directory_root ();
+ }
+#else /* G_OS_WIN32 */
+ tmp = g_strdup (g_getenv ("TMPDIR"));
+
+#ifdef P_tmpdir
+ if (tmp == NULL || *tmp == '\0')
+ {
+ gsize k;
+ g_free (tmp);
+ tmp = g_strdup (P_tmpdir);
+ k = strlen (tmp);
+ if (k > 1 && G_IS_DIR_SEPARATOR (tmp[k - 1]))
+ tmp[k - 1] = '\0';
+ }
+#endif /* P_tmpdir */
+
+ if (tmp == NULL || *tmp == '\0')
+ {
+ g_free (tmp);
+ tmp = g_strdup ("/tmp");
+ }
+#endif /* !G_OS_WIN32 */
+
+ g_once_init_leave (&tmp_dir, tmp);
+ }
+
+ return tmp_dir;
}
/**
* name can be determined, a default fixed string "localhost" is
* returned.
*
- * Returns: the host name of the machine.
+ * The encoding of the returned string is UTF-8.
+ *
+ * Returns: (transfer none): the host name of the machine.
*
* Since: 2.8
*/
const gchar *
g_get_host_name (void)
{
- g_get_any_init_locked ();
- return g_host_name;
+ static gchar *hostname;
+
+ if (g_once_init_enter (&hostname))
+ {
+ gboolean failed;
+ gchar *utmp;
+
+#ifndef G_OS_WIN32
+ gsize size;
+ /* The number 256 * 256 is taken from the value of _POSIX_HOST_NAME_MAX,
+ * which is 255. Since we use _POSIX_HOST_NAME_MAX + 1 (= 256) in the
+ * fallback case, we pick 256 * 256 as the size of the larger buffer here.
+ * It should be large enough. It doesn't looks reasonable to name a host
+ * with a string that is longer than 64 KiB.
+ */
+ const gsize size_large = (gsize) 256 * 256;
+ gchar *tmp;
+
+#ifdef _SC_HOST_NAME_MAX
+ {
+ glong max;
+
+ max = sysconf (_SC_HOST_NAME_MAX);
+ if (max > 0 && (gsize) max <= G_MAXSIZE - 1)
+ size = (gsize) max + 1;
+ else
+#ifdef HOST_NAME_MAX
+ size = HOST_NAME_MAX + 1;
+#else
+ size = _POSIX_HOST_NAME_MAX + 1;
+#endif /* HOST_NAME_MAX */
+ }
+#else
+ /* Fallback to some reasonable value */
+ size = 256;
+#endif /* _SC_HOST_NAME_MAX */
+ tmp = g_malloc (size);
+ failed = (gethostname (tmp, size) == -1);
+ if (failed && size < size_large)
+ {
+ /* Try again with a larger buffer if 'size' may be too small. */
+ g_free (tmp);
+ tmp = g_malloc (size_large);
+ failed = (gethostname (tmp, size_large) == -1);
+ }
+
+ if (failed)
+ g_clear_pointer (&tmp, g_free);
+ utmp = tmp;
+#else
+ wchar_t tmp[MAX_COMPUTERNAME_LENGTH + 1];
+ DWORD size = sizeof (tmp) / sizeof (tmp[0]);
+ failed = (!GetComputerNameW (tmp, &size));
+ if (!failed)
+ utmp = g_utf16_to_utf8 (tmp, size, NULL, NULL, NULL);
+ if (utmp == NULL)
+ failed = TRUE;
+#endif
+
+ g_once_init_leave (&hostname, failed ? g_strdup ("localhost") : utmp);
+ }
+
+ return hostname;
}
G_LOCK_DEFINE_STATIC (g_prgname);
/**
* g_get_prgname:
*
- * Gets the name of the program. This name should <emphasis>not</emphasis>
- * be localized, contrast with g_get_application_name().
- * (If you are using GDK or GTK+ the program name is set in gdk_init(),
- * which is called by gtk_init(). The program name is found by taking
- * the last component of <literal>argv[0]</literal>.)
+ * Gets the name of the program. This name should not be localized,
+ * in contrast to g_get_application_name().
*
- * Returns: the name of the program. The returned string belongs
- * to GLib and must not be modified or freed.
+ * If you are using #GApplication the program name is set in
+ * g_application_run(). In case of GDK or GTK+ it is set in
+ * gdk_init(), which is called by gtk_init() and the
+ * #GtkApplication::startup handler. The program name is found by
+ * taking the last component of @argv[0].
+ *
+ * Returns: (nullable) (transfer none): the name of the program,
+ * or %NULL if it has not been set yet. The returned string belongs
+ * to GLib and must not be modified or freed.
*/
-gchar*
+const gchar*
g_get_prgname (void)
{
gchar* retval;
G_LOCK (g_prgname);
-#ifdef G_OS_WIN32
- if (g_prgname == NULL)
- {
- static gboolean beenhere = FALSE;
-
- if (!beenhere)
- {
- gchar *utf8_buf = NULL;
- wchar_t buf[MAX_PATH+1];
-
- beenhere = TRUE;
- if (GetModuleFileNameW (GetModuleHandle (NULL),
- buf, G_N_ELEMENTS (buf)) > 0)
- utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
-
- if (utf8_buf)
- {
- g_prgname = g_path_get_basename (utf8_buf);
- g_free (utf8_buf);
- }
- }
- }
-#endif
retval = g_prgname;
G_UNLOCK (g_prgname);
* g_set_prgname:
* @prgname: the name of the program.
*
- * Sets the name of the program. This name should <emphasis>not</emphasis>
- * be localized, contrast with g_set_application_name(). Note that for
- * thread-safety reasons this function can only be called once.
+ * Sets the name of the program. This name should not be localized,
+ * in contrast to g_set_application_name().
+ *
+ * If you are using #GApplication the program name is set in
+ * g_application_run(). In case of GDK or GTK+ it is set in
+ * gdk_init(), which is called by gtk_init() and the
+ * #GtkApplication::startup handler. The program name is found by
+ * taking the last component of @argv[0].
+ *
+ * Note that for thread-safety reasons this function can only be called once.
*/
void
g_set_prgname (const gchar *prgname)
* g_get_prgname() (which may be %NULL if g_set_prgname() has also not
* been called).
*
- * Return value: human-readable application name. may return %NULL
+ * Returns: (transfer none) (nullable): human-readable application
+ * name. May return %NULL
*
* Since: 2.2
**/
g_warning ("g_set_application_name() called multiple times");
}
-/**
- * g_get_user_data_dir:
- *
- * Returns a base directory in which to access application data such
- * as icons that is customized for a particular user.
- *
- * On UNIX platforms this is determined using the mechanisms described in
- * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
- * XDG Base Directory Specification</ulink>.
- * In this case the directory retrieved will be XDG_DATA_HOME.
- *
- * On Windows this is the folder to use for local (as opposed to
- * roaming) application data. See documentation for
- * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
- * what g_get_user_config_dir() returns.
- *
- * Return value: a string owned by GLib that must not be modified
- * or freed.
- * Since: 2.6
- **/
-const gchar *
-g_get_user_data_dir (void)
-{
- gchar *data_dir;
+#ifdef G_OS_WIN32
+/* For the past versions we can just
+ * hardcode all the names.
+ */
+static const struct winver
+{
+ gint major;
+ gint minor;
+ gint sp;
+ const char *version;
+ const char *spversion;
+} versions[] =
+{
+ {6, 2, 0, "8", ""},
+ {6, 1, 1, "7", " SP1"},
+ {6, 1, 0, "7", ""},
+ {6, 0, 2, "Vista", " SP2"},
+ {6, 0, 1, "Vista", " SP1"},
+ {6, 0, 0, "Vista", ""},
+ {5, 1, 3, "XP", " SP3"},
+ {5, 1, 2, "XP", " SP2"},
+ {5, 1, 1, "XP", " SP1"},
+ {5, 1, 0, "XP", ""},
+ {0, 0, 0, NULL, NULL},
+};
- G_LOCK (g_utils_global);
+static gchar *
+get_registry_str (HKEY root_key, const wchar_t *path, const wchar_t *value_name)
+{
+ HKEY key_handle;
+ DWORD req_value_data_size;
+ DWORD req_value_data_size2;
+ LONG status;
+ DWORD value_type_w;
+ DWORD value_type_w2;
+ char *req_value_data;
+ gchar *result;
+
+ status = RegOpenKeyExW (root_key, path, 0, KEY_READ, &key_handle);
+ if (status != ERROR_SUCCESS)
+ return NULL;
- if (!g_user_data_dir)
+ req_value_data_size = 0;
+ status = RegQueryValueExW (key_handle,
+ value_name,
+ NULL,
+ &value_type_w,
+ NULL,
+ &req_value_data_size);
+
+ if (status != ERROR_MORE_DATA && status != ERROR_SUCCESS)
{
-#ifdef G_OS_WIN32
- data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
-#else
- data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
+ RegCloseKey (key_handle);
- if (data_dir && data_dir[0])
- data_dir = g_strdup (data_dir);
-#endif
- if (!data_dir || !data_dir[0])
- {
- g_get_any_init ();
+ return NULL;
+ }
- if (g_home_dir)
- data_dir = g_build_filename (g_home_dir, ".local",
- "share", NULL);
- else
- data_dir = g_build_filename (g_tmp_dir, g_user_name, ".local",
- "share", NULL);
- }
+ req_value_data = g_malloc (req_value_data_size);
+ req_value_data_size2 = req_value_data_size;
- g_user_data_dir = data_dir;
- }
- else
- data_dir = g_user_data_dir;
+ status = RegQueryValueExW (key_handle,
+ value_name,
+ NULL,
+ &value_type_w2,
+ (gpointer) req_value_data,
+ &req_value_data_size2);
- G_UNLOCK (g_utils_global);
+ result = NULL;
- return data_dir;
+ if (status == ERROR_SUCCESS && value_type_w2 == REG_SZ)
+ result = g_utf16_to_utf8 ((gunichar2 *) req_value_data,
+ req_value_data_size / sizeof (gunichar2),
+ NULL,
+ NULL,
+ NULL);
+
+ g_free (req_value_data);
+ RegCloseKey (key_handle);
+
+ return result;
}
-static void
-g_init_user_config_dir (void)
+/* Windows 8.1 can be either plain or with Update 1,
+ * depending on its build number (9200 or 9600).
+ */
+static gchar *
+get_windows_8_1_update (void)
{
- gchar *config_dir;
+ gchar *current_build;
+ gchar *result = NULL;
+
+ current_build = get_registry_str (HKEY_LOCAL_MACHINE,
+ L"SOFTWARE"
+ L"\\Microsoft"
+ L"\\Windows NT"
+ L"\\CurrentVersion",
+ L"CurrentBuild");
- if (!g_user_config_dir)
+ if (current_build != NULL)
{
-#ifdef G_OS_WIN32
- config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
-#else
- config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
+ wchar_t *end;
+ long build = wcstol ((const wchar_t *) current_build, &end, 10);
- if (config_dir && config_dir[0])
- config_dir = g_strdup (config_dir);
-#endif
- if (!config_dir || !config_dir[0])
- {
- g_get_any_init ();
+ if (build <= INT_MAX &&
+ build >= INT_MIN &&
+ errno == 0 &&
+ *end == L'\0')
+ {
+ if (build >= 9600)
+ result = g_strdup ("Update 1");
+ }
+ }
- if (g_home_dir)
- config_dir = g_build_filename (g_home_dir, ".config", NULL);
- else
- config_dir = g_build_filename (g_tmp_dir, g_user_name, ".config", NULL);
- }
+ g_clear_pointer (¤t_build, g_free);
- g_user_config_dir = config_dir;
- }
+ return result;
}
-/**
- * g_get_user_config_dir:
- *
- * Returns a base directory in which to store user-specific application
- * configuration information such as user preferences and settings.
- *
- * On UNIX platforms this is determined using the mechanisms described in
- * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
- * XDG Base Directory Specification</ulink>.
- * In this case the directory retrieved will be XDG_CONFIG_HOME.
- *
- * On Windows this is the folder to use for local (as opposed to
- * roaming) application data. See documentation for
- * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
- * what g_get_user_data_dir() returns.
- *
- * Return value: a string owned by GLib that must not be modified
- * or freed.
- * Since: 2.6
- **/
-const gchar *
-g_get_user_config_dir (void)
+static gchar *
+get_windows_version (gboolean with_windows)
{
- G_LOCK (g_utils_global);
+ GString *version = g_string_new (NULL);
- g_init_user_config_dir ();
+ if (g_win32_check_windows_version (10, 0, 0, G_WIN32_OS_ANY))
+ {
+ gchar *win10_release;
- G_UNLOCK (g_utils_global);
+ g_string_append (version, "10");
- return g_user_config_dir;
-}
+ if (!g_win32_check_windows_version (10, 0, 0, G_WIN32_OS_WORKSTATION))
+ g_string_append (version, " Server");
-/**
- * g_get_user_cache_dir:
- *
- * Returns a base directory in which to store non-essential, cached
- * data specific to particular user.
- *
- * On UNIX platforms this is determined using the mechanisms described in
- * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
- * XDG Base Directory Specification</ulink>.
- * In this case the directory retrieved will be XDG_CACHE_HOME.
- *
- * On Windows is the directory that serves as a common repository for
- * temporary Internet files. A typical path is
- * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
- * See documentation for CSIDL_INTERNET_CACHE.
- *
- * Return value: a string owned by GLib that must not be modified
- * or freed.
- * Since: 2.6
- **/
-const gchar *
-g_get_user_cache_dir (void)
-{
- gchar *cache_dir;
+ /* Windows 10 is identified by its release number, such as
+ * 1511, 1607, 1703, 1709, 1803, 1809 or 1903.
+ * The first version of Windows 10 has no release number.
+ */
+ win10_release = get_registry_str (HKEY_LOCAL_MACHINE,
+ L"SOFTWARE"
+ L"\\Microsoft"
+ L"\\Windows NT"
+ L"\\CurrentVersion",
+ L"ReleaseId");
- G_LOCK (g_utils_global);
+ if (win10_release != NULL)
+ g_string_append_printf (version, " %s", win10_release);
- if (!g_user_cache_dir)
+ g_free (win10_release);
+ }
+ else if (g_win32_check_windows_version (6, 3, 0, G_WIN32_OS_ANY))
{
-#ifdef G_OS_WIN32
- cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
-#else
- cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
+ gchar *win81_update;
- if (cache_dir && cache_dir[0])
- cache_dir = g_strdup (cache_dir);
-#endif
- if (!cache_dir || !cache_dir[0])
- {
- g_get_any_init ();
-
- if (g_home_dir)
- cache_dir = g_build_filename (g_home_dir, ".cache", NULL);
- else
- cache_dir = g_build_filename (g_tmp_dir, g_user_name, ".cache", NULL);
- }
- g_user_cache_dir = cache_dir;
+ g_string_append (version, "8.1");
+
+ if (!g_win32_check_windows_version (6, 3, 0, G_WIN32_OS_WORKSTATION))
+ g_string_append (version, " Server");
+
+ win81_update = get_windows_8_1_update ();
+
+ if (win81_update != NULL)
+ g_string_append_printf (version, " %s", win81_update);
+
+ g_free (win81_update);
}
else
- cache_dir = g_user_cache_dir;
+ {
+ gint i;
- G_UNLOCK (g_utils_global);
+ for (i = 0; versions[i].major > 0; i++)
+ {
+ if (!g_win32_check_windows_version (versions[i].major, versions[i].minor, versions[i].sp, G_WIN32_OS_ANY))
+ continue;
- return cache_dir;
-}
+ g_string_append (version, versions[i].version);
-/**
- * g_get_user_runtime_dir:
- *
- * Returns a directory that is unique to the current user on the local
- * system.
- *
- * On UNIX platforms this is determined using the mechanisms described in
- * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
- * XDG Base Directory Specification</ulink>. This is the directory
- * specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
- * In the case that this variable is not set, GLib will issue a warning
- * message to stderr and return the value of g_get_user_cache_dir().
- *
- * On Windows this is the folder to use for local (as opposed to
- * roaming) application data. See documentation for
- * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
- * what g_get_user_config_dir() returns.
- *
- * Returns: a string owned by GLib that must not be modified or freed.
+ if (!g_win32_check_windows_version (versions[i].major, versions[i].minor, versions[i].sp, G_WIN32_OS_WORKSTATION))
+ g_string_append (version, " Server");
+
+ g_string_append (version, versions[i].spversion);
+ }
+ }
+
+ if (version->len == 0)
+ {
+ g_string_free (version, TRUE);
+
+ return NULL;
+ }
+
+ if (with_windows)
+ g_string_prepend (version, "Windows ");
+
+ return g_string_free (version, FALSE);
+}
+#endif
+
+#ifdef G_OS_UNIX
+static gchar *
+get_os_info_from_os_release (const gchar *key_name,
+ const gchar *buffer)
+{
+ GStrv lines;
+ gchar *prefix;
+ size_t i;
+ gchar *result = NULL;
+
+ lines = g_strsplit (buffer, "\n", -1);
+ prefix = g_strdup_printf ("%s=", key_name);
+ for (i = 0; lines[i] != NULL; i++)
+ {
+ const gchar *line = lines[i];
+ const gchar *value;
+
+ if (g_str_has_prefix (line, prefix))
+ {
+ value = line + strlen (prefix);
+ result = g_shell_unquote (value, NULL);
+ if (result == NULL)
+ result = g_strdup (value);
+ break;
+ }
+ }
+ g_strfreev (lines);
+ g_free (prefix);
+
+#ifdef __linux__
+ /* Default values in spec */
+ if (result == NULL)
+ {
+ if (g_str_equal (key_name, G_OS_INFO_KEY_NAME))
+ return g_strdup ("Linux");
+ if (g_str_equal (key_name, G_OS_INFO_KEY_ID))
+ return g_strdup ("linux");
+ if (g_str_equal (key_name, G_OS_INFO_KEY_PRETTY_NAME))
+ return g_strdup ("Linux");
+ }
+#endif
+
+ return g_steal_pointer (&result);
+}
+
+static gchar *
+get_os_info_from_uname (const gchar *key_name)
+{
+ struct utsname info;
+
+ if (uname (&info) == -1)
+ return NULL;
+
+ if (strcmp (key_name, G_OS_INFO_KEY_NAME) == 0)
+ return g_strdup (info.sysname);
+ else if (strcmp (key_name, G_OS_INFO_KEY_VERSION) == 0)
+ return g_strdup (info.release);
+ else if (strcmp (key_name, G_OS_INFO_KEY_PRETTY_NAME) == 0)
+ return g_strdup_printf ("%s %s", info.sysname, info.release);
+ else if (strcmp (key_name, G_OS_INFO_KEY_ID) == 0)
+ {
+ gchar *result = g_ascii_strdown (info.sysname, -1);
+
+ g_strcanon (result, "abcdefghijklmnopqrstuvwxyz0123456789_-.", '_');
+ return g_steal_pointer (&result);
+ }
+ else if (strcmp (key_name, G_OS_INFO_KEY_VERSION_ID) == 0)
+ {
+ /* We attempt to convert the version string to the format returned by
+ * config.guess, which is the script used to generate target triplets
+ * in GNU autotools. There are a lot of rules in the script. We only
+ * implement a few rules which are easy to understand here.
+ *
+ * config.guess can be found at https://savannah.gnu.org/projects/config.
+ */
+ gchar *result;
+
+ if (strcmp (info.sysname, "NetBSD") == 0)
+ {
+ /* sed -e 's,[-_].*,,' */
+ gssize len = G_MAXSSIZE;
+ const gchar *c;
+
+ if ((c = strchr (info.release, '-')) != NULL)
+ len = MIN (len, c - info.release);
+ if ((c = strchr (info.release, '_')) != NULL)
+ len = MIN (len, c - info.release);
+ if (len == G_MAXSSIZE)
+ len = -1;
+
+ result = g_ascii_strdown (info.release, len);
+ }
+ else if (strcmp (info.sysname, "GNU") == 0)
+ {
+ /* sed -e 's,/.*$,,' */
+ gssize len = -1;
+ const gchar *c = strchr (info.release, '/');
+
+ if (c != NULL)
+ len = c - info.release;
+
+ result = g_ascii_strdown (info.release, len);
+ }
+ else if (g_str_has_prefix (info.sysname, "GNU/") ||
+ strcmp (info.sysname, "FreeBSD") == 0 ||
+ strcmp (info.sysname, "DragonFly") == 0)
+ {
+ /* sed -e 's,[-(].*,,' */
+ gssize len = G_MAXSSIZE;
+ const gchar *c;
+
+ if ((c = strchr (info.release, '-')) != NULL)
+ len = MIN (len, c - info.release);
+ if ((c = strchr (info.release, '(')) != NULL)
+ len = MIN (len, c - info.release);
+ if (len == G_MAXSSIZE)
+ len = -1;
+
+ result = g_ascii_strdown (info.release, len);
+ }
+ else
+ result = g_ascii_strdown (info.release, -1);
+
+ g_strcanon (result, "abcdefghijklmnopqrstuvwxyz0123456789_-.", '_');
+ return g_steal_pointer (&result);
+ }
+ else
+ return NULL;
+}
+#endif
+
+/**
+ * g_get_os_info:
+ * @key_name: a key for the OS info being requested, for example %G_OS_INFO_KEY_NAME.
*
- * Since: 2.28
+ * Get information about the operating system.
+ *
+ * On Linux this comes from the `/etc/os-release` file. On other systems, it may
+ * come from a variety of sources. You can either use the standard key names
+ * like %G_OS_INFO_KEY_NAME or pass any UTF-8 string key name. For example,
+ * `/etc/os-release` provides a number of other less commonly used values that may
+ * be useful. No key is guaranteed to be provided, so the caller should always
+ * check if the result is %NULL.
+ *
+ * Returns: (nullable): The associated value for the requested key or %NULL if
+ * this information is not provided.
+ *
+ * Since: 2.64
**/
-const gchar *
-g_get_user_runtime_dir (void)
+gchar *
+g_get_os_info (const gchar *key_name)
{
-#ifndef G_OS_WIN32
- static const gchar *runtime_dir;
- static gsize initialised;
+#if defined (__APPLE__)
+ if (g_strcmp0 (key_name, G_OS_INFO_KEY_NAME) == 0)
+ return g_strdup ("macOS");
+ else
+ return NULL;
+#elif defined (G_OS_UNIX)
+ const gchar * const os_release_files[] = { "/etc/os-release", "/usr/lib/os-release" };
+ gsize i;
+ gchar *buffer = NULL;
+ gchar *result = NULL;
- if (g_once_init_enter (&initialised))
+ g_return_val_if_fail (key_name != NULL, NULL);
+
+ for (i = 0; i < G_N_ELEMENTS (os_release_files); i++)
{
- runtime_dir = g_strdup (getenv ("XDG_RUNTIME_DIR"));
-
- g_once_init_leave (&initialised, 1);
+ GError *error = NULL;
+ gboolean file_missing;
+
+ if (g_file_get_contents (os_release_files[i], &buffer, NULL, &error))
+ break;
+
+ file_missing = g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT);
+ g_clear_error (&error);
+
+ if (!file_missing)
+ return NULL;
}
- if (runtime_dir)
- return runtime_dir;
+ if (buffer != NULL)
+ result = get_os_info_from_os_release (key_name, buffer);
+ else
+ result = get_os_info_from_uname (key_name);
- /* Both fallback for UNIX and the default
- * in Windows: use the user cache directory.
- */
+ g_free (buffer);
+ return g_steal_pointer (&result);
+#elif defined (G_OS_WIN32)
+ if (g_strcmp0 (key_name, G_OS_INFO_KEY_NAME) == 0)
+ return g_strdup ("Windows");
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_ID) == 0)
+ return g_strdup ("windows");
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_PRETTY_NAME) == 0)
+ /* Windows XP SP2 or Windows 10 1903 or Windows 7 Server SP1 */
+ return get_windows_version (TRUE);
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_VERSION) == 0)
+ /* XP SP2 or 10 1903 or 7 Server SP1 */
+ return get_windows_version (FALSE);
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_VERSION_ID) == 0)
+ {
+ /* xp_sp2 or 10_1903 or 7_server_sp1 */
+ gchar *result;
+ gchar *version = get_windows_version (FALSE);
+
+ if (version == NULL)
+ return NULL;
+
+ result = g_ascii_strdown (version, -1);
+ g_free (version);
+
+ return g_strcanon (result, "abcdefghijklmnopqrstuvwxyz0123456789_-.", '_');
+ }
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_HOME_URL) == 0)
+ return g_strdup ("https://microsoft.com/windows/");
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_DOCUMENTATION_URL) == 0)
+ return g_strdup ("https://docs.microsoft.com/");
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_SUPPORT_URL) == 0)
+ return g_strdup ("https://support.microsoft.com/");
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_BUG_REPORT_URL) == 0)
+ return g_strdup ("https://support.microsoft.com/contactus/");
+ else if (g_strcmp0 (key_name, G_OS_INFO_KEY_PRIVACY_POLICY_URL) == 0)
+ return g_strdup ("https://privacy.microsoft.com/");
+ else
+ return NULL;
#endif
+}
+
+/* Set @global_str to a copy of @new_value if it’s currently unset or has a
+ * different value. If its current value matches @new_value, do nothing. If
+ * replaced, we have to leak the old value as client code could still have
+ * pointers to it. */
+static void
+set_str_if_different (gchar **global_str,
+ const gchar *type,
+ const gchar *new_value)
+{
+ if (*global_str == NULL ||
+ !g_str_equal (new_value, *global_str))
+ {
+ g_debug ("g_set_user_dirs: Setting %s to %s", type, new_value);
+
+ /* We have to leak the old value, as user code could be retaining pointers
+ * to it. */
+ *global_str = g_strdup (new_value);
+ }
+}
+
+static void
+set_strv_if_different (gchar ***global_strv,
+ const gchar *type,
+ const gchar * const *new_value)
+{
+ if (*global_strv == NULL ||
+ !g_strv_equal (new_value, (const gchar * const *) *global_strv))
+ {
+ gchar *new_value_str = g_strjoinv (":", (gchar **) new_value);
+ g_debug ("g_set_user_dirs: Setting %s to %s", type, new_value_str);
+ g_free (new_value_str);
- return g_get_user_cache_dir ();
+ /* We have to leak the old value, as user code could be retaining pointers
+ * to it. */
+ *global_strv = g_strdupv ((gchar **) new_value);
+ }
}
-#ifdef HAVE_CARBON
+/*
+ * g_set_user_dirs:
+ * @first_dir_type: Type of the first directory to set
+ * @...: Value to set the first directory to, followed by additional type/value
+ * pairs, followed by %NULL
+ *
+ * Set one or more ‘user’ directories to custom values. This is intended to be
+ * used by test code (particularly with the %G_TEST_OPTION_ISOLATE_DIRS option)
+ * to override the values returned by the following functions, so that test
+ * code can be run without touching an installed system and user data:
+ *
+ * - g_get_home_dir() — use type `HOME`, pass a string
+ * - g_get_user_cache_dir() — use type `XDG_CACHE_HOME`, pass a string
+ * - g_get_system_config_dirs() — use type `XDG_CONFIG_DIRS`, pass a
+ * %NULL-terminated string array
+ * - g_get_user_config_dir() — use type `XDG_CONFIG_HOME`, pass a string
+ * - g_get_system_data_dirs() — use type `XDG_DATA_DIRS`, pass a
+ * %NULL-terminated string array
+ * - g_get_user_data_dir() — use type `XDG_DATA_HOME`, pass a string
+ * - g_get_user_runtime_dir() — use type `XDG_RUNTIME_DIR`, pass a string
+ *
+ * The list must be terminated with a %NULL type. All of the values must be
+ * non-%NULL — passing %NULL as a value won’t reset a directory. If a reference
+ * to a directory from the calling environment needs to be kept, copy it before
+ * the first call to g_set_user_dirs(). g_set_user_dirs() can be called multiple
+ * times.
+ *
+ * Since: 2.60
+ */
+/*< private > */
+void
+g_set_user_dirs (const gchar *first_dir_type,
+ ...)
+{
+ va_list args;
+ const gchar *dir_type;
+
+ G_LOCK (g_utils_global);
+
+ va_start (args, first_dir_type);
+
+ for (dir_type = first_dir_type; dir_type != NULL; dir_type = va_arg (args, const gchar *))
+ {
+ gconstpointer dir_value = va_arg (args, gconstpointer);
+ g_assert (dir_value != NULL);
+
+ if (g_str_equal (dir_type, "HOME"))
+ set_str_if_different (&g_home_dir, dir_type, dir_value);
+ else if (g_str_equal (dir_type, "XDG_CACHE_HOME"))
+ set_str_if_different (&g_user_cache_dir, dir_type, dir_value);
+ else if (g_str_equal (dir_type, "XDG_CONFIG_DIRS"))
+ set_strv_if_different (&g_system_config_dirs, dir_type, dir_value);
+ else if (g_str_equal (dir_type, "XDG_CONFIG_HOME"))
+ set_str_if_different (&g_user_config_dir, dir_type, dir_value);
+ else if (g_str_equal (dir_type, "XDG_DATA_DIRS"))
+ set_strv_if_different (&g_system_data_dirs, dir_type, dir_value);
+ else if (g_str_equal (dir_type, "XDG_DATA_HOME"))
+ set_str_if_different (&g_user_data_dir, dir_type, dir_value);
+ else if (g_str_equal (dir_type, "XDG_RUNTIME_DIR"))
+ set_str_if_different (&g_user_runtime_dir, dir_type, dir_value);
+ else
+ g_assert_not_reached ();
+ }
+
+ va_end (args);
+
+ G_UNLOCK (g_utils_global);
+}
static gchar *
-find_folder (OSType type)
+g_build_user_data_dir (void)
{
- gchar *filename = NULL;
- FSRef found;
+ gchar *data_dir = NULL;
+ const gchar *data_dir_env = g_getenv ("XDG_DATA_HOME");
- if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
+ if (data_dir_env && data_dir_env[0])
+ data_dir = g_strdup (data_dir_env);
+#ifdef G_OS_WIN32
+ else
+ data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
+#endif
+ if (!data_dir || !data_dir[0])
{
- CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
+ gchar *home_dir = g_build_home_dir ();
+ data_dir = g_build_filename (home_dir, ".local", "share", NULL);
+ g_free (home_dir);
+ }
- if (url)
- {
- CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
+ return g_steal_pointer (&data_dir);
+}
- if (path)
- {
- filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
+/**
+ * g_get_user_data_dir:
+ *
+ * Returns a base directory in which to access application data such
+ * as icons that is customized for a particular user.
+ *
+ * On UNIX platforms this is determined using the mechanisms described
+ * in the
+ * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
+ * In this case the directory retrieved will be `XDG_DATA_HOME`.
+ *
+ * On Windows it follows XDG Base Directory Specification if `XDG_DATA_HOME`
+ * is defined. If `XDG_DATA_HOME` is undefined, the folder to use for local (as
+ * opposed to roaming) application data is used instead. See the
+ * [documentation for `CSIDL_LOCAL_APPDATA`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_local_appdata).
+ * Note that in this case on Windows it will be the same
+ * as what g_get_user_config_dir() returns.
+ *
+ * Returns: (type filename) (transfer none): a string owned by GLib that must
+ * not be modified or freed.
+ *
+ * Since: 2.6
+ **/
+const gchar *
+g_get_user_data_dir (void)
+{
+ const gchar *user_data_dir;
- if (! filename)
- {
- filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
+ G_LOCK (g_utils_global);
- CFStringGetCString (path, filename,
- CFStringGetLength (path) * 3 + 1,
- kCFStringEncodingUTF8);
- }
+ if (g_user_data_dir == NULL)
+ g_user_data_dir = g_build_user_data_dir ();
+ user_data_dir = g_user_data_dir;
- CFRelease (path);
- }
+ G_UNLOCK (g_utils_global);
- CFRelease (url);
- }
+ return user_data_dir;
+}
+
+static gchar *
+g_build_user_config_dir (void)
+{
+ gchar *config_dir = NULL;
+ const gchar *config_dir_env = g_getenv ("XDG_CONFIG_HOME");
+
+ if (config_dir_env && config_dir_env[0])
+ config_dir = g_strdup (config_dir_env);
+#ifdef G_OS_WIN32
+ else
+ config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
+#endif
+ if (!config_dir || !config_dir[0])
+ {
+ gchar *home_dir = g_build_home_dir ();
+ config_dir = g_build_filename (home_dir, ".config", NULL);
+ g_free (home_dir);
+ }
+
+ return g_steal_pointer (&config_dir);
+}
+
+/**
+ * g_get_user_config_dir:
+ *
+ * Returns a base directory in which to store user-specific application
+ * configuration information such as user preferences and settings.
+ *
+ * On UNIX platforms this is determined using the mechanisms described
+ * in the
+ * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
+ * In this case the directory retrieved will be `XDG_CONFIG_HOME`.
+ *
+ * On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_HOME` is defined.
+ * If `XDG_CONFIG_HOME` is undefined, the folder to use for local (as opposed
+ * to roaming) application data is used instead. See the
+ * [documentation for `CSIDL_LOCAL_APPDATA`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_local_appdata).
+ * Note that in this case on Windows it will be the same
+ * as what g_get_user_data_dir() returns.
+ *
+ * Returns: (type filename) (transfer none): a string owned by GLib that
+ * must not be modified or freed.
+ * Since: 2.6
+ **/
+const gchar *
+g_get_user_config_dir (void)
+{
+ const gchar *user_config_dir;
+
+ G_LOCK (g_utils_global);
+
+ if (g_user_config_dir == NULL)
+ g_user_config_dir = g_build_user_config_dir ();
+ user_config_dir = g_user_config_dir;
+
+ G_UNLOCK (g_utils_global);
+
+ return user_config_dir;
+}
+
+static gchar *
+g_build_user_cache_dir (void)
+{
+ gchar *cache_dir = NULL;
+ const gchar *cache_dir_env = g_getenv ("XDG_CACHE_HOME");
+
+ if (cache_dir_env && cache_dir_env[0])
+ cache_dir = g_strdup (cache_dir_env);
+#ifdef G_OS_WIN32
+ else
+ cache_dir = get_special_folder (CSIDL_INTERNET_CACHE);
+#endif
+ if (!cache_dir || !cache_dir[0])
+ {
+ gchar *home_dir = g_build_home_dir ();
+ cache_dir = g_build_filename (home_dir, ".cache", NULL);
+ g_free (home_dir);
+ }
+
+ return g_steal_pointer (&cache_dir);
+}
+
+/**
+ * g_get_user_cache_dir:
+ *
+ * Returns a base directory in which to store non-essential, cached
+ * data specific to particular user.
+ *
+ * On UNIX platforms this is determined using the mechanisms described
+ * in the
+ * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
+ * In this case the directory retrieved will be `XDG_CACHE_HOME`.
+ *
+ * On Windows it follows XDG Base Directory Specification if `XDG_CACHE_HOME` is defined.
+ * If `XDG_CACHE_HOME` is undefined, the directory that serves as a common
+ * repository for temporary Internet files is used instead. A typical path is
+ * `C:\Documents and Settings\username\Local Settings\Temporary Internet Files`.
+ * See the [documentation for `CSIDL_INTERNET_CACHE`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_internet_cache).
+ *
+ * Returns: (type filename) (transfer none): a string owned by GLib that
+ * must not be modified or freed.
+ * Since: 2.6
+ **/
+const gchar *
+g_get_user_cache_dir (void)
+{
+ const gchar *user_cache_dir;
+
+ G_LOCK (g_utils_global);
+
+ if (g_user_cache_dir == NULL)
+ g_user_cache_dir = g_build_user_cache_dir ();
+ user_cache_dir = g_user_cache_dir;
+
+ G_UNLOCK (g_utils_global);
+
+ return user_cache_dir;
+}
+
+static gchar *
+g_build_user_runtime_dir (void)
+{
+ gchar *runtime_dir = NULL;
+ const gchar *runtime_dir_env = g_getenv ("XDG_RUNTIME_DIR");
+
+ if (runtime_dir_env && runtime_dir_env[0])
+ runtime_dir = g_strdup (runtime_dir_env);
+ else
+ {
+ runtime_dir = g_build_user_cache_dir ();
+
+ /* The user should be able to rely on the directory existing
+ * when the function returns. Probably it already does, but
+ * let's make sure. Just do mkdir() directly since it will be
+ * no more expensive than a stat() in the case that the
+ * directory already exists and is a lot easier.
+ *
+ * $XDG_CACHE_HOME is probably ~/.cache/ so as long as $HOME
+ * exists this will work. If the user changed $XDG_CACHE_HOME
+ * then they can make sure that it exists...
+ */
+ (void) g_mkdir (runtime_dir, 0700);
}
- return filename;
+ return g_steal_pointer (&runtime_dir);
+}
+
+/**
+ * g_get_user_runtime_dir:
+ *
+ * Returns a directory that is unique to the current user on the local
+ * system.
+ *
+ * This is determined using the mechanisms described
+ * in the
+ * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
+ * This is the directory
+ * specified in the `XDG_RUNTIME_DIR` environment variable.
+ * In the case that this variable is not set, we return the value of
+ * g_get_user_cache_dir(), after verifying that it exists.
+ *
+ * Returns: (type filename): a string owned by GLib that must not be
+ * modified or freed.
+ *
+ * Since: 2.28
+ **/
+const gchar *
+g_get_user_runtime_dir (void)
+{
+ const gchar *user_runtime_dir;
+
+ G_LOCK (g_utils_global);
+
+ if (g_user_runtime_dir == NULL)
+ g_user_runtime_dir = g_build_user_runtime_dir ();
+ user_runtime_dir = g_user_runtime_dir;
+
+ G_UNLOCK (g_utils_global);
+
+ return user_runtime_dir;
}
+#ifdef HAVE_COCOA
+
+/* Implemented in gutils-macos.m */
+void load_user_special_dirs_macos (gchar **table);
+
static void
load_user_special_dirs (void)
{
- g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
- g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
- g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
- g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
- g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
- g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
- g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
- g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
+ load_user_special_dirs_macos (g_user_special_dirs);
}
-#endif /* HAVE_CARBON */
+#elif defined(G_OS_WIN32)
-#if defined(G_OS_WIN32)
static void
load_user_special_dirs (void)
{
wchar_t *wcp;
- p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
+ p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandleW (L"shell32.dll"),
"SHGetKnownFolderPath");
g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
}
-#endif /* G_OS_WIN32 */
-static void g_init_user_config_dir (void);
-
-#if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
+#else /* default is unix */
/* adapted from xdg-user-dir-lookup.c
*
static void
load_user_special_dirs (void)
{
+ gchar *config_dir = NULL;
gchar *config_file;
gchar *data;
gchar **lines;
gint n_lines, i;
- g_init_user_config_dir ();
- config_file = g_build_filename (g_user_config_dir,
+ config_dir = g_build_user_config_dir ();
+ config_file = g_build_filename (config_dir,
"user-dirs.dirs",
NULL);
-
+ g_free (config_dir);
+
if (!g_file_get_contents (config_file, &data, NULL, NULL))
{
g_free (config_file);
if (is_relative)
{
- g_get_any_init ();
- g_user_special_dirs[directory] = g_build_filename (g_home_dir, d, NULL);
+ gchar *home_dir = g_build_home_dir ();
+ g_user_special_dirs[directory] = g_build_filename (home_dir, d, NULL);
+ g_free (home_dir);
}
else
g_user_special_dirs[directory] = g_strdup (d);
g_free (config_file);
}
-#endif /* G_OS_UNIX && !HAVE_CARBON */
+#endif /* platform-specific load_user_special_dirs implementations */
/**
* that the latest on-disk version is used. Call this only
* if you just changed the data on disk yourself.
*
- * Due to threadsafety issues this may cause leaking of strings
+ * Due to thread safety issues this may cause leaking of strings
* that were previously returned from g_get_user_special_dir()
* that can't be freed. We ensure to only leak the data for
* the directories that actually changed value though.
/* only leak changed directories */
for (i = 0; i < G_USER_N_DIRECTORIES; i++)
{
- old_val = old_g_user_special_dirs[i];
- if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
+ old_val = old_g_user_special_dirs[i];
+ if (g_user_special_dirs[i] == NULL)
{
- /* don't leak */
- g_free (g_user_special_dirs[i]);
- g_user_special_dirs[i] = old_val;
+ g_user_special_dirs[i] = old_val;
}
- else
+ else if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
+ {
+ /* don't leak */
+ g_free (g_user_special_dirs[i]);
+ g_user_special_dirs[i] = old_val;
+ }
+ else
g_free (old_val);
}
*
* Returns the full path of a special directory using its logical id.
*
- * On Unix this is done using the XDG special user directories.
+ * On UNIX this is done using the XDG special user directories.
* For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
- * falls back to <filename>$HOME/Desktop</filename> when XDG special
- * user directories have not been set up.
+ * falls back to `$HOME/Desktop` when XDG special user directories have
+ * not been set up.
*
* Depending on the platform, the user might be able to change the path
* of the special directory without requiring the session to restart; GLib
* will not reflect any change once the special directories are loaded.
*
- * Return value: the path to the specified special directory, or %NULL
- * if the logical id was not found. The returned string is owned by
+ * Returns: (type filename): the path to the specified special directory, or
+ * %NULL if the logical id was not found. The returned string is owned by
* GLib and should not be modified or freed.
*
* Since: 2.14
const gchar *
g_get_user_special_dir (GUserDirectory directory)
{
+ const gchar *user_special_dir;
+
g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
directory < G_USER_N_DIRECTORIES, NULL);
/* Special-case desktop for historical compatibility */
if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
{
- g_get_any_init ();
-
- g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] =
- g_build_filename (g_home_dir, "Desktop", NULL);
+ gchar *home_dir = g_build_home_dir ();
+ g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = g_build_filename (home_dir, "Desktop", NULL);
+ g_free (home_dir);
}
}
+ user_special_dir = g_user_special_dirs[directory];
G_UNLOCK (g_utils_global);
- return g_user_special_dirs[directory];
+ return user_special_dir;
}
#ifdef G_OS_WIN32
{
/* Holds the g_utils_global lock */
- static gboolean beenhere = FALSE;
- typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
- static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
HMODULE hmodule = NULL;
if (!address)
return NULL;
- if (!beenhere)
- {
- p_GetModuleHandleExA =
- (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
- "GetModuleHandleExA");
- beenhere = TRUE;
- }
-
- if (p_GetModuleHandleExA == NULL ||
- !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
- GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
- address, &hmodule))
+ if (!GetModuleHandleExW (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
+ GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
+ address, &hmodule))
{
MEMORY_BASIC_INFORMATION mbi;
VirtualQuery (address, &mbi, sizeof (mbi));
return retval;
}
-const gchar * const *
-g_win32_get_system_data_dirs_for_module (void (*address_of_function)())
+static const gchar * const *
+g_win32_get_system_data_dirs_for_module_real (void (*address_of_function)(void))
{
GArray *data_dirs;
HMODULE hmodule;
gchar **retval;
gchar *p;
gchar *exe_root;
-
+
+ hmodule = NULL;
if (address_of_function)
{
G_LOCK (g_utils_global);
return (const gchar * const *) retval;
}
-#endif
+const gchar * const *
+g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void))
+{
+ gboolean should_call_g_get_system_data_dirs;
-/**
- * g_get_system_data_dirs:
- *
+ should_call_g_get_system_data_dirs = TRUE;
+ /* These checks are the same as the ones that g_build_system_data_dirs() does.
+ * Please keep them in sync.
+ */
+ G_LOCK (g_utils_global);
+
+ if (!g_system_data_dirs)
+ {
+ const gchar *data_dirs = g_getenv ("XDG_DATA_DIRS");
+
+ if (!data_dirs || !data_dirs[0])
+ should_call_g_get_system_data_dirs = FALSE;
+ }
+
+ G_UNLOCK (g_utils_global);
+
+ /* There is a subtle difference between g_win32_get_system_data_dirs_for_module (NULL),
+ * which is what GLib code can normally call,
+ * and g_win32_get_system_data_dirs_for_module (&_g_win32_get_system_data_dirs),
+ * which is what the inline function used by non-GLib code calls.
+ * The former gets prefix relative to currently-running executable,
+ * the latter - relative to the module that calls _g_win32_get_system_data_dirs()
+ * (disguised as g_get_system_data_dirs()), which could be an executable or
+ * a DLL that is located somewhere else.
+ * This is why that inline function in gutils.h exists, and why we can't just
+ * call g_get_system_data_dirs() from there - because we need to get the address
+ * local to the non-GLib caller-module.
+ */
+
+ /*
+ * g_get_system_data_dirs() will fall back to calling
+ * g_win32_get_system_data_dirs_for_module_real(NULL) if XDG_DATA_DIRS is NULL
+ * or an empty string. The checks above ensure that we do not call it in such
+ * cases and use the address_of_function that we've been given by the inline function.
+ * The reason we're calling g_get_system_data_dirs /at all/ is to give
+ * XDG_DATA_DIRS precedence (if it is set).
+ */
+ if (should_call_g_get_system_data_dirs)
+ return g_get_system_data_dirs ();
+
+ return g_win32_get_system_data_dirs_for_module_real (address_of_function);
+}
+
+#endif
+
+static gchar **
+g_build_system_data_dirs (void)
+{
+ gchar **data_dir_vector = NULL;
+ gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
+
+ /* These checks are the same as the ones that g_win32_get_system_data_dirs_for_module()
+ * does. Please keep them in sync.
+ */
+#ifndef G_OS_WIN32
+ if (!data_dirs || !data_dirs[0])
+ data_dirs = "/usr/local/share/:/usr/share/";
+
+ data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
+#else
+ if (!data_dirs || !data_dirs[0])
+ data_dir_vector = g_strdupv ((gchar **) g_win32_get_system_data_dirs_for_module_real (NULL));
+ else
+ data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
+#endif
+
+ return g_steal_pointer (&data_dir_vector);
+}
+
+/**
+ * g_get_system_data_dirs:
+ *
* Returns an ordered list of base directories in which to access
* system-wide application data.
*
- * On UNIX platforms this is determined using the mechanisms described in
- * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
- * XDG Base Directory Specification</ulink>
- * In this case the list of directories retrieved will be XDG_DATA_DIRS.
+ * On UNIX platforms this is determined using the mechanisms described
+ * in the
+ * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec)
+ * In this case the list of directories retrieved will be `XDG_DATA_DIRS`.
*
- * On Windows the first elements in the list are the Application Data
+ * On Windows it follows XDG Base Directory Specification if `XDG_DATA_DIRS` is defined.
+ * If `XDG_DATA_DIRS` is undefined,
+ * the first elements in the list are the Application Data
* and Documents folders for All Users. (These can be determined only
* on Windows 2000 or later and are not present in the list on other
* Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
* Note that on Windows the returned list can vary depending on where
* this function is called.
*
- * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
- * not be modified or freed.
+ * Returns: (array zero-terminated=1) (element-type filename) (transfer none):
+ * a %NULL-terminated array of strings owned by GLib that must not be
+ * modified or freed.
+ *
* Since: 2.6
**/
const gchar * const *
g_get_system_data_dirs (void)
{
- gchar **data_dir_vector;
+ const gchar * const *system_data_dirs;
G_LOCK (g_utils_global);
- if (!g_system_data_dirs)
- {
-#ifdef G_OS_WIN32
- data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
-#else
- gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
+ if (g_system_data_dirs == NULL)
+ g_system_data_dirs = g_build_system_data_dirs ();
+ system_data_dirs = (const gchar * const *) g_system_data_dirs;
- if (!data_dirs || !data_dirs[0])
- data_dirs = "/usr/local/share/:/usr/share/";
+ G_UNLOCK (g_utils_global);
- data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
-#endif
+ return system_data_dirs;
+}
- g_system_data_dirs = data_dir_vector;
+static gchar **
+g_build_system_config_dirs (void)
+{
+ gchar **conf_dir_vector = NULL;
+ const gchar *conf_dirs = g_getenv ("XDG_CONFIG_DIRS");
+#ifdef G_OS_WIN32
+ if (conf_dirs)
+ {
+ conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
}
else
- data_dir_vector = g_system_data_dirs;
+ {
+ gchar *special_conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
- G_UNLOCK (g_utils_global);
+ if (special_conf_dirs)
+ conf_dir_vector = g_strsplit (special_conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
+ else
+ /* Return empty list */
+ conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
- return (const gchar * const *) data_dir_vector;
+ g_free (special_conf_dirs);
+ }
+#else
+ if (!conf_dirs || !conf_dirs[0])
+ conf_dirs = "/etc/xdg";
+
+ conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
+#endif
+
+ return g_steal_pointer (&conf_dir_vector);
}
/**
* Returns an ordered list of base directories in which to access
* system-wide configuration information.
*
- * On UNIX platforms this is determined using the mechanisms described in
- * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
- * XDG Base Directory Specification</ulink>.
- * In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
- *
- * On Windows is the directory that contains application data for all users.
- * A typical path is C:\Documents and Settings\All Users\Application Data.
- * This folder is used for application data that is not user specific.
- * For example, an application can store a spell-check dictionary, a database
- * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
- * This information will not roam and is available to anyone using the computer.
- *
- * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
- * not be modified or freed.
+ * On UNIX platforms this is determined using the mechanisms described
+ * in the
+ * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
+ * In this case the list of directories retrieved will be `XDG_CONFIG_DIRS`.
+ *
+ * On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_DIRS` is defined.
+ * If `XDG_CONFIG_DIRS` is undefined, the directory that contains application
+ * data for all users is used instead. A typical path is
+ * `C:\Documents and Settings\All Users\Application Data`.
+ * This folder is used for application data
+ * that is not user specific. For example, an application can store
+ * a spell-check dictionary, a database of clip art, or a log file in the
+ * CSIDL_COMMON_APPDATA folder. This information will not roam and is available
+ * to anyone using the computer.
+ *
+ * Returns: (array zero-terminated=1) (element-type filename) (transfer none):
+ * a %NULL-terminated array of strings owned by GLib that must not be
+ * modified or freed.
+ *
* Since: 2.6
**/
const gchar * const *
g_get_system_config_dirs (void)
{
- gchar *conf_dirs, **conf_dir_vector;
+ const gchar * const *system_config_dirs;
G_LOCK (g_utils_global);
- if (!g_system_config_dirs)
- {
-#ifdef G_OS_WIN32
- conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
- if (conf_dirs)
- {
- conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
- g_free (conf_dirs);
- }
- else
- {
- /* Return empty list */
- conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
- }
-#else
- conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
-
- if (!conf_dirs || !conf_dirs[0])
- conf_dirs = "/etc/xdg";
+ if (g_system_config_dirs == NULL)
+ g_system_config_dirs = g_build_system_config_dirs ();
+ system_config_dirs = (const gchar * const *) g_system_config_dirs;
- conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
-#endif
-
- g_system_config_dirs = conf_dir_vector;
- }
- else
- conf_dir_vector = g_system_config_dirs;
G_UNLOCK (g_utils_global);
- return (const gchar * const *) conf_dir_vector;
-}
-
-#ifndef G_OS_WIN32
-
-static GHashTable *alias_table = NULL;
-
-/* read an alias file for the locales */
-static void
-read_aliases (gchar *file)
-{
- FILE *fp;
- char buf[256];
-
- if (!alias_table)
- alias_table = g_hash_table_new (g_str_hash, g_str_equal);
- fp = fopen (file,"r");
- if (!fp)
- return;
- while (fgets (buf, 256, fp))
- {
- char *p, *q;
-
- g_strstrip (buf);
-
- /* Line is a comment */
- if ((buf[0] == '#') || (buf[0] == '\0'))
- continue;
-
- /* Reads first column */
- for (p = buf, q = NULL; *p; p++) {
- if ((*p == '\t') || (*p == ' ') || (*p == ':')) {
- *p = '\0';
- q = p+1;
- while ((*q == '\t') || (*q == ' ')) {
- q++;
- }
- break;
- }
- }
- /* The line only had one column */
- if (!q || *q == '\0')
- continue;
-
- /* Read second column */
- for (p = q; *p; p++) {
- if ((*p == '\t') || (*p == ' ')) {
- *p = '\0';
- break;
- }
- }
-
- /* Add to alias table if necessary */
- if (!g_hash_table_lookup (alias_table, buf)) {
- g_hash_table_insert (alias_table, g_strdup (buf), g_strdup (q));
- }
- }
- fclose (fp);
+ return system_config_dirs;
}
-#endif
-
-static char *
-unalias_lang (char *lang)
+/**
+ * g_nullify_pointer:
+ * @nullify_location: (not nullable): the memory address of the pointer.
+ *
+ * Set the pointer at the specified location to %NULL.
+ **/
+void
+g_nullify_pointer (gpointer *nullify_location)
{
-#ifndef G_OS_WIN32
- char *p;
- int i;
-
- if (!alias_table)
- read_aliases ("/usr/share/locale/locale.alias");
+ g_return_if_fail (nullify_location != NULL);
- i = 0;
- while ((p = g_hash_table_lookup (alias_table, lang)) && (strcmp (p, lang) != 0))
- {
- lang = p;
- if (i++ == 30)
- {
- static gboolean said_before = FALSE;
- if (!said_before)
- g_warning ("Too many alias levels for a locale, "
- "may indicate a loop");
- said_before = TRUE;
- return lang;
- }
- }
-#endif
- return lang;
+ *nullify_location = NULL;
}
-/* Mask for components of locale spec. The ordering here is from
- * least significant to most significant
- */
-enum
-{
- COMPONENT_CODESET = 1 << 0,
- COMPONENT_TERRITORY = 1 << 1,
- COMPONENT_MODIFIER = 1 << 2
-};
-
-/* Break an X/Open style locale specification into components
- */
-static guint
-explode_locale (const gchar *locale,
- gchar **language,
- gchar **territory,
- gchar **codeset,
- gchar **modifier)
-{
- const gchar *uscore_pos;
- const gchar *at_pos;
- const gchar *dot_pos;
-
- guint mask = 0;
-
- uscore_pos = strchr (locale, '_');
- dot_pos = strchr (uscore_pos ? uscore_pos : locale, '.');
- at_pos = strchr (dot_pos ? dot_pos : (uscore_pos ? uscore_pos : locale), '@');
-
- if (at_pos)
- {
- mask |= COMPONENT_MODIFIER;
- *modifier = g_strdup (at_pos);
- }
- else
- at_pos = locale + strlen (locale);
-
- if (dot_pos)
- {
- mask |= COMPONENT_CODESET;
- *codeset = g_strndup (dot_pos, at_pos - dot_pos);
- }
- else
- dot_pos = at_pos;
-
- if (uscore_pos)
- {
- mask |= COMPONENT_TERRITORY;
- *territory = g_strndup (uscore_pos, dot_pos - uscore_pos);
- }
- else
- uscore_pos = dot_pos;
-
- *language = g_strndup (locale, uscore_pos - locale);
+#define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
+#define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
+#define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
+#define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
+#define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
+#define EXABYTE_FACTOR (PETABYTE_FACTOR * KILOBYTE_FACTOR)
- return mask;
-}
+#define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
+#define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
+#define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
+#define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
+#define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
+#define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
-/*
- * Compute all interesting variants for a given locale name -
- * by stripping off different components of the value.
+/**
+ * g_format_size:
+ * @size: a size in bytes
+ *
+ * Formats a size (for example the size of a file) into a human readable
+ * string. Sizes are rounded to the nearest size prefix (kB, MB, GB)
+ * and are displayed rounded to the nearest tenth. E.g. the file size
+ * 3292528 bytes will be converted into the string "3.2 MB". The returned string
+ * is UTF-8, and may use a non-breaking space to separate the number and units,
+ * to ensure they aren’t separated when line wrapped.
*
- * For simplicity, we assume that the locale is in
- * X/Open format: language[_territory][.codeset][@modifier]
+ * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
*
- * TODO: Extend this to handle the CEN format (see the GNUlibc docs)
- * as well. We could just copy the code from glibc wholesale
- * but it is big, ugly, and complicated, so I'm reluctant
- * to do so when this should handle 99% of the time...
+ * This string should be freed with g_free() when not needed any longer.
+ *
+ * See g_format_size_full() for more options about how the size might be
+ * formatted.
+ *
+ * Returns: (transfer full): a newly-allocated formatted string containing
+ * a human readable file size
+ *
+ * Since: 2.30
*/
-static void
-append_locale_variants (GPtrArray *array,
- const gchar *locale)
+gchar *
+g_format_size (guint64 size)
{
- gchar *language = NULL;
- gchar *territory = NULL;
- gchar *codeset = NULL;
- gchar *modifier = NULL;
-
- guint mask;
- guint i, j;
-
- g_return_if_fail (locale != NULL);
-
- mask = explode_locale (locale, &language, &territory, &codeset, &modifier);
-
- /* Iterate through all possible combinations, from least attractive
- * to most attractive.
- */
- for (j = 0; j <= mask; ++j)
- {
- i = mask - j;
+ return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
+}
- if ((i & ~mask) == 0)
- {
- gchar *val = g_strconcat (language,
- (i & COMPONENT_TERRITORY) ? territory : "",
- (i & COMPONENT_CODESET) ? codeset : "",
- (i & COMPONENT_MODIFIER) ? modifier : "",
- NULL);
- g_ptr_array_add (array, val);
- }
- }
+/**
+ * GFormatSizeFlags:
+ * @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
+ * @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
+ * of the returned string. For example, "45.6 kB (45,612 bytes)".
+ * @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
+ * suffixes. IEC units should only be used for reporting things with
+ * a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
+ * Network and storage sizes should be reported in the normal SI units.
+ * @G_FORMAT_SIZE_BITS: set the size as a quantity in bits, rather than
+ * bytes, and return units in bits. For example, ‘Mb’ rather than ‘MB’.
+ *
+ * Flags to modify the format of the string returned by g_format_size_full().
+ */
- g_free (language);
- if (mask & COMPONENT_CODESET)
- g_free (codeset);
- if (mask & COMPONENT_TERRITORY)
- g_free (territory);
- if (mask & COMPONENT_MODIFIER)
- g_free (modifier);
-}
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wformat-nonliteral"
/**
- * g_get_locale_variants:
- * @locale: a locale identifier
+ * g_format_size_full:
+ * @size: a size in bytes
+ * @flags: #GFormatSizeFlags to modify the output
*
- * Returns a list of derived variants of @locale, which can be used to
- * e.g. construct locale-dependent filenames or search paths. The returned
- * list is sorted from most desirable to least desirable.
- * This function handles territory, charset and extra locale modifiers.
- *
- * For example, if @locale is "fr_BE", then the returned list
- * is "fr_BE", "fr".
+ * Formats a size.
*
- * If you need the list of variants for the <emphasis>current locale</emphasis>,
- * use g_get_language_names().
+ * This function is similar to g_format_size() but allows for flags
+ * that modify the output. See #GFormatSizeFlags.
*
- * Returns: (transfer full) (array zero-terminated=1) (element-type utf8): a newly
- * allocated array of newly allocated strings with the locale variants. Free with
- * g_strfreev().
+ * Returns: (transfer full): a newly-allocated formatted string
+ * containing a human readable file size
*
- * Since: 2.28
+ * Since: 2.30
*/
-gchar **
-g_get_locale_variants (const gchar *locale)
-{
- GPtrArray *array;
-
- g_return_val_if_fail (locale != NULL, NULL);
-
- array = g_ptr_array_sized_new (8);
- append_locale_variants (array, locale);
- g_ptr_array_add (array, NULL);
-
- return (gchar **) g_ptr_array_free (array, FALSE);
-}
-
-/* The following is (partly) taken from the gettext package.
- Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc. */
-
-static const gchar *
-guess_category_value (const gchar *category_name)
+gchar *
+g_format_size_full (guint64 size,
+ GFormatSizeFlags flags)
{
- const gchar *retval;
-
- /* The highest priority value is the `LANGUAGE' environment
- variable. This is a GNU extension. */
- retval = g_getenv ("LANGUAGE");
- if ((retval != NULL) && (retval[0] != '\0'))
- return retval;
-
- /* `LANGUAGE' is not set. So we have to proceed with the POSIX
- methods of looking to `LC_ALL', `LC_xxx', and `LANG'. On some
- systems this can be done by the `setlocale' function itself. */
-
- /* Setting of LC_ALL overwrites all other. */
- retval = g_getenv ("LC_ALL");
- if ((retval != NULL) && (retval[0] != '\0'))
- return retval;
-
- /* Next comes the name of the desired category. */
- retval = g_getenv (category_name);
- if ((retval != NULL) && (retval[0] != '\0'))
- return retval;
-
- /* Last possibility is the LANG environment variable. */
- retval = g_getenv ("LANG");
- if ((retval != NULL) && (retval[0] != '\0'))
- return retval;
-
-#ifdef G_PLATFORM_WIN32
- /* g_win32_getlocale() first checks for LC_ALL, LC_MESSAGES and
- * LANG, which we already did above. Oh well. The main point of
- * calling g_win32_getlocale() is to get the thread's locale as used
- * by Windows and the Microsoft C runtime (in the "English_United
- * States" format) translated into the Unixish format.
- */
+ struct Format
{
- char *locale = g_win32_getlocale ();
- retval = g_intern_string (locale);
- g_free (locale);
- return retval;
- }
-#endif
-
- return NULL;
-}
+ guint64 factor;
+ char string[10];
+ };
-typedef struct _GLanguageNamesCache GLanguageNamesCache;
+ typedef enum
+ {
+ FORMAT_BYTES,
+ FORMAT_BYTES_IEC,
+ FORMAT_BITS,
+ FORMAT_BITS_IEC
+ } FormatIndex;
-struct _GLanguageNamesCache {
- gchar *languages;
- gchar **language_names;
-};
+ const struct Format formats[4][6] = {
+ {
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { KILOBYTE_FACTOR, N_("%.1f kB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { MEGABYTE_FACTOR, N_("%.1f MB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { GIGABYTE_FACTOR, N_("%.1f GB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { TERABYTE_FACTOR, N_("%.1f TB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { PETABYTE_FACTOR, N_("%.1f PB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { EXABYTE_FACTOR, N_("%.1f EB") }
+ },
+ {
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { KIBIBYTE_FACTOR, N_("%.1f KiB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { MEBIBYTE_FACTOR, N_("%.1f MiB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { GIBIBYTE_FACTOR, N_("%.1f GiB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { TEBIBYTE_FACTOR, N_("%.1f TiB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { PEBIBYTE_FACTOR, N_("%.1f PiB") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { EXBIBYTE_FACTOR, N_("%.1f EiB") }
+ },
+ {
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { KILOBYTE_FACTOR, N_("%.1f kb") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { MEGABYTE_FACTOR, N_("%.1f Mb") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { GIGABYTE_FACTOR, N_("%.1f Gb") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { TERABYTE_FACTOR, N_("%.1f Tb") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { PETABYTE_FACTOR, N_("%.1f Pb") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { EXABYTE_FACTOR, N_("%.1f Eb") }
+ },
+ {
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { KIBIBYTE_FACTOR, N_("%.1f Kib") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { MEBIBYTE_FACTOR, N_("%.1f Mib") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { GIBIBYTE_FACTOR, N_("%.1f Gib") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { TEBIBYTE_FACTOR, N_("%.1f Tib") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { PEBIBYTE_FACTOR, N_("%.1f Pib") },
+ /* Translators: Keep the no-break space between %.1f and the unit symbol */
+ { EXBIBYTE_FACTOR, N_("%.1f Eib") }
+ }
+ };
-static void
-language_names_cache_free (gpointer data)
-{
- GLanguageNamesCache *cache = data;
- g_free (cache->languages);
- g_strfreev (cache->language_names);
- g_free (cache);
-}
+ GString *string;
+ FormatIndex index;
-/**
- * g_get_language_names:
- *
- * Computes a list of applicable locale names, which can be used to
- * e.g. construct locale-dependent filenames or search paths. The returned
- * list is sorted from most desirable to least desirable and always contains
- * the default locale "C".
- *
- * For example, if LANGUAGE=de:en_US, then the returned list is
- * "de", "en_US", "en", "C".
- *
- * This function consults the environment variables <envar>LANGUAGE</envar>,
- * <envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar>
- * to find the list of locales specified by the user.
- *
- * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib
- * that must not be modified or freed.
- *
- * Since: 2.6
- **/
-const gchar * const *
-g_get_language_names (void)
-{
- static GPrivate cache_private = G_PRIVATE_INIT (language_names_cache_free);
- GLanguageNamesCache *cache = g_private_get (&cache_private);
- const gchar *value;
+ string = g_string_new (NULL);
- if (!cache)
+ switch (flags & ~G_FORMAT_SIZE_LONG_FORMAT)
{
- cache = g_new0 (GLanguageNamesCache, 1);
- g_private_set (&cache_private, cache);
+ case G_FORMAT_SIZE_DEFAULT:
+ index = FORMAT_BYTES;
+ break;
+ case (G_FORMAT_SIZE_DEFAULT | G_FORMAT_SIZE_IEC_UNITS):
+ index = FORMAT_BYTES_IEC;
+ break;
+ case G_FORMAT_SIZE_BITS:
+ index = FORMAT_BITS;
+ break;
+ case (G_FORMAT_SIZE_BITS | G_FORMAT_SIZE_IEC_UNITS):
+ index = FORMAT_BITS_IEC;
+ break;
+ default:
+ g_assert_not_reached ();
}
- value = guess_category_value ("LC_MESSAGES");
- if (!value)
- value = "C";
- if (!(cache->languages && strcmp (cache->languages, value) == 0))
+ if (size < formats[index][0].factor)
{
- GPtrArray *array;
- gchar **alist, **a;
+ const char * format;
- g_free (cache->languages);
- g_strfreev (cache->language_names);
- cache->languages = g_strdup (value);
-
- array = g_ptr_array_sized_new (8);
+ if (index == FORMAT_BYTES || index == FORMAT_BYTES_IEC)
+ {
+ format = g_dngettext (GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size);
+ }
+ else
+ {
+ format = g_dngettext (GETTEXT_PACKAGE, "%u bit", "%u bits", (guint) size);
+ }
- alist = g_strsplit (value, ":", 0);
- for (a = alist; *a; a++)
- append_locale_variants (array, unalias_lang (*a));
- g_strfreev (alist);
- g_ptr_array_add (array, g_strdup ("C"));
- g_ptr_array_add (array, NULL);
+ g_string_printf (string, format, (guint) size);
- cache->language_names = (gchar **) g_ptr_array_free (array, FALSE);
+ flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
}
+ else
+ {
+ const gsize n = G_N_ELEMENTS (formats[index]);
+ gsize i;
- return (const gchar * const *) cache->language_names;
-}
-
-/**
- * g_nullify_pointer:
- * @nullify_location: the memory address of the pointer.
- *
- * Set the pointer at the specified location to %NULL.
- **/
-void
-g_nullify_pointer (gpointer *nullify_location)
-{
- g_return_if_fail (nullify_location != NULL);
-
- *nullify_location = NULL;
-}
-
-#ifdef G_OS_WIN32
+ /*
+ * Point the last format (the highest unit) by default
+ * and then then scan all formats, starting with the 2nd one
+ * because the 1st is already managed by with the plural form
+ */
+ const struct Format * f = &formats[index][n - 1];
-/**
- * _glib_get_locale_dir:
- *
- * Return the path to the share\locale or lib\locale subfolder of the
- * GLib installation folder. The path is in the system codepage. We
- * have to use system codepage as bindtextdomain() doesn't have a
- * UTF-8 interface.
- */
-gchar *
-_glib_get_locale_dir (void)
-{
- gchar *install_dir = NULL, *locale_dir;
- gchar *retval = NULL;
+ for (i = 1; i < n; i++)
+ {
+ if (size < formats[index][i].factor)
+ {
+ f = &formats[index][i - 1];
+ break;
+ }
+ }
- if (glib_dll != NULL)
- install_dir = g_win32_get_package_installation_directory_of_module (glib_dll);
+ g_string_printf (string, _(f->string), (gdouble) size / (gdouble) f->factor);
+ }
- if (install_dir)
+ if (flags & G_FORMAT_SIZE_LONG_FORMAT)
{
- /*
- * Append "/share/locale" or "/lib/locale" depending on whether
- * autoconfigury detected GNU gettext or not.
+ /* First problem: we need to use the number of bytes to decide on
+ * the plural form that is used for display, but the number of
+ * bytes potentially exceeds the size of a guint (which is what
+ * ngettext() takes).
+ *
+ * From a pragmatic standpoint, it seems that all known languages
+ * base plural forms on one or both of the following:
+ *
+ * - the lowest digits of the number
+ *
+ * - if the number if greater than some small value
+ *
+ * Here's how we fake it: Draw an arbitrary line at one thousand.
+ * If the number is below that, then fine. If it is above it,
+ * then we take the modulus of the number by one thousand (in
+ * order to keep the lowest digits) and add one thousand to that
+ * (in order to ensure that 1001 is not treated the same as 1).
*/
- const char *p = GLIB_LOCALE_DIR + strlen (GLIB_LOCALE_DIR);
- while (*--p != '/')
- ;
- while (*--p != '/')
- ;
-
- locale_dir = g_build_filename (install_dir, p, NULL);
+ guint plural_form = size < 1000 ? size : size % 1000 + 1000;
+
+ /* Second problem: we need to translate the string "%u byte/bit" and
+ * "%u bytes/bits" for pluralisation, but the correct number format to
+ * use for a gsize is different depending on which architecture
+ * we're on.
+ *
+ * Solution: format the number separately and use "%s bytes/bits" on
+ * all platforms.
+ */
+ const gchar *translated_format;
+ gchar *formatted_number;
- retval = g_win32_locale_filename_from_utf8 (locale_dir);
+ if (index == FORMAT_BYTES || index == FORMAT_BYTES_IEC)
+ {
+ /* Translators: the %s in "%s bytes" will always be replaced by a number. */
+ translated_format = g_dngettext (GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
+ }
+ else
+ {
+ /* Translators: the %s in "%s bits" will always be replaced by a number. */
+ translated_format = g_dngettext (GETTEXT_PACKAGE, "%s bit", "%s bits", plural_form);
+ }
+ formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
- g_free (install_dir);
- g_free (locale_dir);
+ g_string_append (string, " (");
+ g_string_append_printf (string, translated_format, formatted_number);
+ g_free (formatted_number);
+ g_string_append (string, ")");
}
- if (retval)
- return retval;
- else
- return g_strdup ("");
+ return g_string_free (string, FALSE);
}
-#undef GLIB_LOCALE_DIR
-
-#endif /* G_OS_WIN32 */
-
-static void
-ensure_gettext_initialized (void)
-{
- static gsize initialised;
-
- if (g_once_init_enter (&initialised))
- {
-#ifdef G_OS_WIN32
- gchar *tmp = _glib_get_locale_dir ();
- bindtextdomain (GETTEXT_PACKAGE, tmp);
- g_free (tmp);
-#else
- bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
-#endif
-# ifdef HAVE_BIND_TEXTDOMAIN_CODESET
- bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
-# endif
- g_once_init_leave (&initialised, TRUE);
- }
-}
+#pragma GCC diagnostic pop
/**
- * glib_gettext:
- * @str: The string to be translated
+ * g_format_size_for_display:
+ * @size: a size in bytes
*
- * Returns the translated string from the glib translations.
- * This is an internal function and should only be used by
- * the internals of glib (such as libgio).
+ * Formats a size (for example the size of a file) into a human
+ * readable string. Sizes are rounded to the nearest size prefix
+ * (KB, MB, GB) and are displayed rounded to the nearest tenth.
+ * E.g. the file size 3292528 bytes will be converted into the
+ * string "3.1 MB".
*
- * Returns: the transation of @str to the current locale
- */
-const gchar *
-glib_gettext (const gchar *str)
-{
- ensure_gettext_initialized();
-
- return g_dgettext (GETTEXT_PACKAGE, str);
-}
-
-/**
- * glib_pgettext:
- * @msgctxtid: a combined message context and message id, separated
- * by a \004 character
- * @msgidoffset: the offset of the message id in @msgctxid
+ * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
*
- * This function is a variant of glib_gettext() which supports
- * a disambiguating message context. See g_dpgettext() for full
- * details.
+ * This string should be freed with g_free() when not needed any longer.
*
- * This is an internal function and should only be used by
- * the internals of glib (such as libgio).
+ * Returns: (transfer full): a newly-allocated formatted string
+ * containing a human readable file size
*
- * Returns: the transation of @str to the current locale
+ * Since: 2.16
+ *
+ * Deprecated:2.30: This function is broken due to its use of SI
+ * suffixes to denote IEC units. Use g_format_size() instead.
*/
-const gchar *
-glib_pgettext(const gchar *msgctxtid,
- gsize msgidoffset)
+gchar *
+g_format_size_for_display (goffset size)
{
- ensure_gettext_initialized();
+ if (size < (goffset) KIBIBYTE_FACTOR)
+ return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
+ else
+ {
+ gdouble displayed_size;
- return g_dpgettext (GETTEXT_PACKAGE, msgctxtid, msgidoffset);
+ if (size < (goffset) MEBIBYTE_FACTOR)
+ {
+ displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
+ /* Translators: this is from the deprecated function g_format_size_for_display() which uses 'KB' to
+ * mean 1024 bytes. I am aware that 'KB' is not correct, but it has been preserved for reasons of
+ * compatibility. Users will not see this string unless a program is using this deprecated function.
+ * Please translate as literally as possible.
+ */
+ return g_strdup_printf (_("%.1f KB"), displayed_size);
+ }
+ else if (size < (goffset) GIBIBYTE_FACTOR)
+ {
+ displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
+ return g_strdup_printf (_("%.1f MB"), displayed_size);
+ }
+ else if (size < (goffset) TEBIBYTE_FACTOR)
+ {
+ displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
+ return g_strdup_printf (_("%.1f GB"), displayed_size);
+ }
+ else if (size < (goffset) PEBIBYTE_FACTOR)
+ {
+ displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
+ return g_strdup_printf (_("%.1f TB"), displayed_size);
+ }
+ else if (size < (goffset) EXBIBYTE_FACTOR)
+ {
+ displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
+ return g_strdup_printf (_("%.1f PB"), displayed_size);
+ }
+ else
+ {
+ displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
+ return g_strdup_printf (_("%.1f EB"), displayed_size);
+ }
+ }
}
#if defined (G_OS_WIN32) && !defined (_WIN64)
/* Binary compatibility versions. Not for newly compiled code. */
-#undef g_find_program_in_path
-
-gchar*
-g_find_program_in_path (const gchar *program)
-{
- gchar *utf8_program = g_locale_to_utf8 (program, -1, NULL, NULL, NULL);
- gchar *utf8_retval = g_find_program_in_path_utf8 (utf8_program);
- gchar *retval;
-
- g_free (utf8_program);
- if (utf8_retval == NULL)
- return NULL;
- retval = g_locale_from_utf8 (utf8_retval, -1, NULL, NULL, NULL);
- g_free (utf8_retval);
+_GLIB_EXTERN const gchar *g_get_user_name_utf8 (void);
+_GLIB_EXTERN const gchar *g_get_real_name_utf8 (void);
+_GLIB_EXTERN const gchar *g_get_home_dir_utf8 (void);
+_GLIB_EXTERN const gchar *g_get_tmp_dir_utf8 (void);
+_GLIB_EXTERN gchar *g_find_program_in_path_utf8 (const gchar *program);
- return retval;
-}
-
-#undef g_get_current_dir
-
-gchar*
-g_get_current_dir (void)
+gchar *
+g_find_program_in_path_utf8 (const gchar *program)
{
- gchar *utf8_dir = g_get_current_dir_utf8 ();
- gchar *dir = g_locale_from_utf8 (utf8_dir, -1, NULL, NULL, NULL);
- g_free (utf8_dir);
- return dir;
+ return g_find_program_in_path (program);
}
-#undef g_getenv
-
-const gchar *
-g_getenv (const gchar *variable)
-{
- gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
- const gchar *utf8_value = g_getenv_utf8 (utf8_variable);
- gchar *value;
- GQuark quark;
-
- g_free (utf8_variable);
- if (!utf8_value)
- return NULL;
- value = g_locale_from_utf8 (utf8_value, -1, NULL, NULL, NULL);
- quark = g_quark_from_string (value);
- g_free (value);
-
- return g_quark_to_string (quark);
-}
+const gchar *g_get_user_name_utf8 (void) { return g_get_user_name (); }
+const gchar *g_get_real_name_utf8 (void) { return g_get_real_name (); }
+const gchar *g_get_home_dir_utf8 (void) { return g_get_home_dir (); }
+const gchar *g_get_tmp_dir_utf8 (void) { return g_get_tmp_dir (); }
-#undef g_setenv
+#endif
+/* Private API:
+ *
+ * Returns %TRUE if the current process was executed as setuid
+ */
gboolean
-g_setenv (const gchar *variable,
- const gchar *value,
- gboolean overwrite)
-{
- gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
- gchar *utf8_value = g_locale_to_utf8 (value, -1, NULL, NULL, NULL);
- gboolean retval = g_setenv_utf8 (utf8_variable, utf8_value, overwrite);
-
- g_free (utf8_variable);
- g_free (utf8_value);
-
- return retval;
-}
-
-#undef g_unsetenv
-
-void
-g_unsetenv (const gchar *variable)
-{
- gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
-
- g_unsetenv_utf8 (utf8_variable);
-
- g_free (utf8_variable);
-}
-
-#undef g_get_user_name
-
-const gchar *
-g_get_user_name (void)
-{
- g_get_any_init_locked ();
- return g_user_name_cp;
-}
+g_check_setuid (void)
+{
+#if defined(HAVE_SYS_AUXV_H) && defined(HAVE_GETAUXVAL) && defined(AT_SECURE)
+ unsigned long value;
+ int errsv;
+
+ errno = 0;
+ value = getauxval (AT_SECURE);
+ errsv = errno;
+ if (errsv)
+ g_error ("getauxval () failed: %s", g_strerror (errsv));
+ return value;
+#elif defined(HAVE_ISSETUGID) && !defined(__BIONIC__)
+ /* BSD: http://www.freebsd.org/cgi/man.cgi?query=issetugid&sektion=2 */
+
+ /* Android had it in older versions but the new 64 bit ABI does not
+ * have it anymore, and some versions of the 32 bit ABI neither.
+ * https://code.google.com/p/android-developer-preview/issues/detail?id=168
+ */
+ return issetugid ();
+#elif defined(G_OS_UNIX)
+ uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
+ gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
-#undef g_get_real_name
+ static gsize check_setuid_initialised;
+ static gboolean is_setuid;
-const gchar *
-g_get_real_name (void)
-{
- g_get_any_init_locked ();
- return g_real_name_cp;
-}
+ if (g_once_init_enter (&check_setuid_initialised))
+ {
+#ifdef HAVE_GETRESUID
+ /* These aren't in the header files, so we prototype them here.
+ */
+ int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
+ int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
+
+ if (getresuid (&ruid, &euid, &suid) != 0 ||
+ getresgid (&rgid, &egid, &sgid) != 0)
+#endif /* HAVE_GETRESUID */
+ {
+ suid = ruid = getuid ();
+ sgid = rgid = getgid ();
+ euid = geteuid ();
+ egid = getegid ();
+ }
-#undef g_get_home_dir
+ is_setuid = (ruid != euid || ruid != suid ||
+ rgid != egid || rgid != sgid);
-const gchar *
-g_get_home_dir (void)
-{
- g_get_any_init_locked ();
- return g_home_dir_cp;
+ g_once_init_leave (&check_setuid_initialised, 1);
+ }
+ return is_setuid;
+#else
+ return FALSE;
+#endif
}
-#undef g_get_tmp_dir
-
-const gchar *
-g_get_tmp_dir (void)
+#ifdef G_OS_WIN32
+/**
+ * g_abort:
+ *
+ * A wrapper for the POSIX abort() function.
+ *
+ * On Windows it is a function that makes extra effort (including a call
+ * to abort()) to ensure that a debugger-catchable exception is thrown
+ * before the program terminates.
+ *
+ * See your C library manual for more details about abort().
+ *
+ * Since: 2.50
+ */
+void
+g_abort (void)
{
- g_get_any_init_locked ();
- return g_tmp_dir_cp;
+ /* One call to break the debugger */
+ DebugBreak ();
+ /* One call in case CRT changes its abort() behaviour */
+ abort ();
+ /* And one call to bind them all and terminate the program for sure */
+ ExitProcess (127);
}
-
#endif
projects / platform / upstream / glib.git / blobdiff