1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1998 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
28 * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
46 #include <sys/types.h>
47 #ifdef HAVE_SYS_PARAM_H
48 #include <sys/param.h>
51 /* implement gutils's inline functions
53 #define G_IMPLEMENT_INLINES 1
58 #define G_PATH_LENGTH MAXPATHLEN
59 #elif defined (PATH_MAX)
60 #define G_PATH_LENGTH PATH_MAX
61 #elif defined (_PC_PATH_MAX)
62 #define G_PATH_LENGTH sysconf(_PC_PATH_MAX)
64 #define G_PATH_LENGTH 2048
67 #ifdef G_PLATFORM_WIN32
68 # define STRICT /* Strict typing, please */
72 #endif /* G_PLATFORM_WIN32 */
82 const guint glib_major_version = GLIB_MAJOR_VERSION;
83 const guint glib_minor_version = GLIB_MINOR_VERSION;
84 const guint glib_micro_version = GLIB_MICRO_VERSION;
85 const guint glib_interface_age = GLIB_INTERFACE_AGE;
86 const guint glib_binary_age = GLIB_BINARY_AGE;
88 #if !defined (HAVE_MEMMOVE) && !defined (HAVE_WORKING_BCOPY)
90 g_memmove (gpointer dest, gconstpointer src, gulong len)
92 gchar* destptr = dest;
93 const gchar* srcptr = src;
94 if (src + len < dest || dest + len < src)
96 bcopy (src, dest, len);
102 *(destptr++) = *(srcptr++);
109 *(--destptr) = *(--srcptr);
112 #endif /* !HAVE_MEMMOVE && !HAVE_WORKING_BCOPY */
115 g_atexit (GVoidFunc func)
118 const gchar *error = NULL;
120 /* keep this in sync with glib.h */
122 #ifdef G_NATIVE_ATEXIT
123 result = ATEXIT (func);
125 error = g_strerror (errno);
126 #elif defined (HAVE_ATEXIT)
127 # ifdef NeXT /* @#%@! NeXTStep */
128 result = !atexit ((void (*)(void)) func);
130 error = g_strerror (errno);
132 result = atexit ((void (*)(void)) func);
134 error = g_strerror (errno);
136 #elif defined (HAVE_ON_EXIT)
137 result = on_exit ((void (*)(int, void *)) func, NULL);
139 error = g_strerror (errno);
142 error = "no implementation";
143 #endif /* G_NATIVE_ATEXIT */
146 g_error ("Could not register atexit() function: %s", error);
149 /* Based on execvp() from GNU Libc.
150 * Some of this code is cut-and-pasted into gspawn.c
154 my_strchrnul (const gchar *str, gchar c)
156 gchar *p = (gchar*)str;
157 while (*p && (*p != c))
165 gchar *inner_find_program_in_path (const gchar *program);
168 g_find_program_in_path (const gchar *program)
170 const gchar *last_dot = strrchr (program, '.');
172 if (last_dot == NULL || strchr (last_dot, '\\') != NULL)
174 const gint program_length = strlen (program);
175 const gchar *pathext = getenv ("PATHEXT");
177 gchar *decorated_program;
181 pathext = ".com;.exe;.bat";
187 p = my_strchrnul (pathext, ';');
189 decorated_program = g_malloc (program_length + (p-pathext) + 1);
190 memcpy (decorated_program, program, program_length);
191 memcpy (decorated_program+program_length, pathext, p-pathext);
192 decorated_program [program_length + (p-pathext)] = '\0';
194 retval = inner_find_program_in_path (decorated_program);
195 g_free (decorated_program);
199 } while (*p++ != '\0');
203 return inner_find_program_in_path (program);
206 #define g_find_program_in_path inner_find_program_in_path
210 * g_find_program_in_path:
211 * @program: a program name
213 * Locates the first executable named @program in the user's path, in the
214 * same way that execvp() would locate it. Returns an allocated string
215 * with the absolute path name, or NULL if the program is not found in
216 * the path. If @program is already an absolute path, returns a copy of
217 * @program if @program exists and is executable, and NULL otherwise.
219 * On Windows, if @program does not have a file type suffix, tries to
220 * append the suffixes in the PATHEXT environment variable (if that
221 * doesn't exists, the suffixes .com, .exe, and .bat) in turn, and
222 * then look for the resulting file name in the same way as
223 * CreateProcess() would. This means first in the directory where the
224 * program was loaded from, then in the current directory, then in the
225 * Windows 32-bit system directory, then in the Windows directory, and
226 * finally in the directories in the PATH environment variable. If
227 * the program is found, the return value contains the full name
228 * including the type suffix.
230 * Return value: absolute path, or NULL
233 g_find_program_in_path (const gchar *program)
235 const gchar *path, *p;
236 gchar *name, *freeme;
243 g_return_val_if_fail (program != NULL, NULL);
245 /* If it is an absolute path, or a relative path including subdirectories,
246 * don't look in PATH.
248 if (g_path_is_absolute (program)
249 || strchr (program, G_DIR_SEPARATOR) != NULL)
251 if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE))
252 return g_strdup (program);
257 path = g_getenv ("PATH");
261 /* There is no `PATH' in the environment. The default
262 * search path in GNU libc is the current directory followed by
263 * the path `confstr' returns for `_CS_PATH'.
266 /* In GLib we put . last, for security, and don't use the
267 * unportable confstr(); UNIX98 does not actually specify
268 * what to search if PATH is unset. POSIX may, dunno.
271 path = "/bin:/usr/bin:.";
276 gchar moddir[MAXPATHLEN], sysdir[MAXPATHLEN], windir[MAXPATHLEN];
278 GetModuleFileName (NULL, moddir, sizeof (moddir));
279 tmp = g_path_get_dirname (moddir);
280 GetSystemDirectory (sysdir, sizeof (sysdir));
281 GetWindowsDirectory (windir, sizeof (windir));
282 path_tmp = g_strconcat (tmp, ";.;", sysdir, ";", windir,
283 (path != NULL ? ";" : NULL),
284 (path != NULL ? path : NULL),
291 len = strlen (program) + 1;
292 pathlen = strlen (path);
293 freeme = name = g_malloc (pathlen + len + 1);
295 /* Copy the file name at the top, including '\0' */
296 memcpy (name + pathlen + 1, program, len);
297 name = name + pathlen;
298 /* And add the slash before the filename */
299 *name = G_DIR_SEPARATOR;
307 p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
310 /* Two adjacent colons, or a colon at the beginning or the end
311 * of `PATH' means to search the current directory.
315 startp = memcpy (name - (p - path), path, p - path);
317 if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE))
320 ret = g_strdup (startp);
328 while (*p++ != '\0');
339 g_snprintf (gchar *str,
347 va_start (args, fmt);
348 retval = g_vsnprintf (str, n, fmt, args);
355 g_vsnprintf (gchar *str,
360 #ifdef HAVE_VSNPRINTF_C99
361 g_return_val_if_fail (n == 0 || str != NULL, 0);
362 g_return_val_if_fail (fmt != NULL, 0);
364 return vsnprintf (str, n, fmt, args);
365 #else /* !HAVE_VSNPRINTF_C99 */
369 g_return_val_if_fail (n == 0 || str != NULL, 0);
370 g_return_val_if_fail (fmt != NULL, 0);
372 printed = g_strdup_vprintf (fmt, args);
373 retval = strlen (printed);
376 strncpy (str, printed, n - 1);
383 #endif /* !HAVE_VSNPRINTF_C99 */
387 g_parse_debug_string (const gchar *string,
388 const GDebugKey *keys,
394 g_return_val_if_fail (string != NULL, 0);
396 if (!g_ascii_strcasecmp (string, "all"))
398 for (i=0; i<nkeys; i++)
399 result |= keys[i].value;
403 const gchar *p = string;
405 gboolean done = FALSE;
416 for (i=0; i<nkeys; i++)
417 if (g_ascii_strncasecmp(keys[i].key, p, q - p) == 0 &&
418 keys[i].key[q - p] == '\0')
419 result |= keys[i].value;
428 G_CONST_RETURN gchar*
429 g_basename (const gchar *file_name)
431 register gchar *base;
433 g_return_val_if_fail (file_name != NULL, NULL);
435 base = strrchr (file_name, G_DIR_SEPARATOR);
440 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
441 return (gchar*) file_name + 2;
442 #endif /* G_OS_WIN32 */
444 return (gchar*) file_name;
448 g_path_get_basename (const gchar *file_name)
450 register gssize base;
451 register gssize last_nonslash;
455 g_return_val_if_fail (file_name != NULL, NULL);
457 if (file_name[0] == '\0')
459 return g_strdup (".");
461 last_nonslash = strlen (file_name) - 1;
463 while (last_nonslash >= 0 && file_name [last_nonslash] == G_DIR_SEPARATOR)
466 if (last_nonslash == -1)
467 /* string only containing slashes */
468 return g_strdup (G_DIR_SEPARATOR_S);
471 if (last_nonslash == 1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
472 /* string only containing slashes and a drive */
473 return g_strdup (G_DIR_SEPARATOR_S);
474 #endif /* G_OS_WIN32 */
476 base = last_nonslash;
478 while (base >=0 && file_name [base] != G_DIR_SEPARATOR)
482 if (base == -1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
484 #endif /* G_OS_WIN32 */
486 len = last_nonslash - base;
487 retval = g_malloc (len + 1);
488 memcpy (retval, file_name + base + 1, len);
494 g_path_is_absolute (const gchar *file_name)
496 g_return_val_if_fail (file_name != NULL, FALSE);
498 if (file_name[0] == G_DIR_SEPARATOR
500 || file_name[0] == '/'
506 /* Recognize drive letter on native Windows */
507 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':' && (file_name[2] == G_DIR_SEPARATOR || file_name[2] == '/'))
509 #endif /* G_OS_WIN32 */
514 G_CONST_RETURN gchar*
515 g_path_skip_root (const gchar *file_name)
517 g_return_val_if_fail (file_name != NULL, NULL);
519 #ifdef G_PLATFORM_WIN32
520 /* Skip \\server\share (Win32) or //server/share (Cygwin) */
521 if (file_name[0] == G_DIR_SEPARATOR &&
522 file_name[1] == G_DIR_SEPARATOR &&
527 if ((p = strchr (file_name + 2, G_DIR_SEPARATOR)) > file_name + 2 &&
532 while (file_name[0] && file_name[0] != G_DIR_SEPARATOR)
535 /* Possibly skip a backslash after the share name */
536 if (file_name[0] == G_DIR_SEPARATOR)
539 return (gchar *)file_name;
544 /* Skip initial slashes */
545 if (file_name[0] == G_DIR_SEPARATOR)
547 while (file_name[0] == G_DIR_SEPARATOR)
549 return (gchar *)file_name;
554 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':' && file_name[2] == G_DIR_SEPARATOR)
555 return (gchar *)file_name + 3;
562 g_path_get_dirname (const gchar *file_name)
564 register gchar *base;
567 g_return_val_if_fail (file_name != NULL, NULL);
569 base = strrchr (file_name, G_DIR_SEPARATOR);
571 return g_strdup (".");
572 while (base > file_name && *base == G_DIR_SEPARATOR)
574 len = (guint) 1 + base - file_name;
576 base = g_new (gchar, len + 1);
577 g_memmove (base, file_name, len);
584 g_get_current_dir (void)
586 gchar *buffer = NULL;
588 static gulong max_len = 0;
591 max_len = (G_PATH_LENGTH == -1) ? 2048 : G_PATH_LENGTH;
593 /* We don't use getcwd(3) on SUNOS, because, it does a popen("pwd")
594 * and, if that wasn't bad enough, hangs in doing so.
596 #if (defined (sun) && !defined (__SVR4)) || !defined(HAVE_GETCWD)
597 buffer = g_new (gchar, max_len + 1);
599 dir = getwd (buffer);
600 #else /* !sun || !HAVE_GETCWD */
601 while (max_len < G_MAXULONG / 2)
603 buffer = g_new (gchar, max_len + 1);
605 dir = getcwd (buffer, max_len);
607 if (dir || errno != ERANGE)
613 #endif /* !sun || !HAVE_GETCWD */
615 if (!dir || !*buffer)
617 /* hm, should we g_error() out here?
618 * this can happen if e.g. "./" has mode \0000
620 buffer[0] = G_DIR_SEPARATOR;
624 dir = g_strdup (buffer);
630 G_CONST_RETURN gchar*
631 g_getenv (const gchar *variable)
634 g_return_val_if_fail (variable != NULL, NULL);
636 return getenv (variable);
638 G_LOCK_DEFINE_STATIC (getenv);
644 static GArray *environs = NULL;
649 g_return_val_if_fail (variable != NULL, NULL);
654 environs = g_array_new (FALSE, FALSE, sizeof (struct env_struct));
656 /* First we try to find the envinronment variable inside the already
660 for (i = 0; i < environs->len; i++)
662 env = &g_array_index (environs, struct env_struct, i);
663 if (strcmp (env->key, variable) == 0)
665 g_assert (env->value);
671 /* If not found, we ask the system */
673 system_env = getenv (variable);
680 /* On Windows NT, it is relatively typical that environment variables
681 * contain references to other environment variables. Handle that by
682 * calling ExpandEnvironmentStrings.
685 g_array_set_size (environs, environs->len + 1);
687 env = &g_array_index (environs, struct env_struct, environs->len - 1);
689 /* First check how much space we need */
690 length = ExpandEnvironmentStrings (system_env, dummy, 2);
692 /* Then allocate that much, and actualy do the expansion and insert
693 * the new found pair into our buffer
696 env->value = g_malloc (length);
697 env->key = g_strdup (variable);
699 ExpandEnvironmentStrings (system_env, env->value, length);
707 G_LOCK_DEFINE_STATIC (g_utils_global);
709 static gchar *g_tmp_dir = NULL;
710 static gchar *g_user_name = NULL;
711 static gchar *g_real_name = NULL;
712 static gchar *g_home_dir = NULL;
714 /* HOLDS: g_utils_global_lock */
716 g_get_any_init (void)
720 g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
722 g_tmp_dir = g_strdup (g_getenv ("TMP"));
724 g_tmp_dir = g_strdup (g_getenv ("TEMP"));
730 g_tmp_dir = g_strdup (P_tmpdir);
731 k = strlen (g_tmp_dir);
732 if (k > 1 && g_tmp_dir[k - 1] == G_DIR_SEPARATOR)
733 g_tmp_dir[k - 1] = '\0';
740 g_tmp_dir = g_strdup ("/tmp");
741 #else /* G_OS_WIN32 */
742 g_tmp_dir = g_strdup ("C:\\");
743 #endif /* G_OS_WIN32 */
747 g_home_dir = g_strdup (g_getenv ("HOME"));
750 /* In case HOME is Unix-style (it happens), convert it to
756 while ((p = strchr (g_home_dir, '/')) != NULL)
762 /* USERPROFILE is probably the closest equivalent to $HOME? */
763 if (getenv ("USERPROFILE") != NULL)
764 g_home_dir = g_strdup (g_getenv ("USERPROFILE"));
769 /* At least at some time, HOMEDRIVE and HOMEPATH were used
770 * to point to the home directory, I think. But on Windows
771 * 2000 HOMEDRIVE seems to be equal to SYSTEMDRIVE, and
772 * HOMEPATH is its root "\"?
774 if (getenv ("HOMEDRIVE") != NULL && getenv ("HOMEPATH") != NULL)
776 gchar *homedrive, *homepath;
778 homedrive = g_strdup (g_getenv ("HOMEDRIVE"));
779 homepath = g_strdup (g_getenv ("HOMEPATH"));
781 g_home_dir = g_strconcat (homedrive, homepath, NULL);
786 #endif /* G_OS_WIN32 */
790 struct passwd *pw = NULL;
791 gpointer buffer = NULL;
794 # if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
796 # ifdef _SC_GETPW_R_SIZE_MAX
797 /* This reurns the maximum length */
798 glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
802 # else /* _SC_GETPW_R_SIZE_MAX */
804 # endif /* _SC_GETPW_R_SIZE_MAX */
809 buffer = g_malloc (bufsize);
812 # ifdef HAVE_POSIX_GETPWUID_R
813 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
814 error = error < 0 ? errno : error;
815 # else /* HAVE_NONPOSIX_GETPWUID_R */
817 error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
818 pw = error == 0 ? &pwd : NULL;
820 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
821 error = pw ? 0 : errno;
823 # endif /* HAVE_NONPOSIX_GETPWUID_R */
827 /* we bail out prematurely if the user id can't be found
828 * (should be pretty rare case actually), or if the buffer
829 * should be sufficiently big and lookups are still not
832 if (error == 0 || error == ENOENT)
834 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
838 if (bufsize > 32 * 1024)
840 g_warning ("getpwuid_r(): failed due to: %s.",
849 # endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
854 pw = getpwuid (getuid ());
859 g_user_name = g_strdup (pw->pw_name);
860 g_real_name = g_strdup (pw->pw_gecos);
862 g_home_dir = g_strdup (pw->pw_dir);
867 #else /* !HAVE_PWD_H */
874 if (GetUserName ((LPTSTR) buffer, (LPDWORD) &len))
876 g_user_name = g_strdup (buffer);
877 g_real_name = g_strdup (buffer);
880 # endif /* G_OS_WIN32 */
882 #endif /* !HAVE_PWD_H */
885 /* change '\\' in %HOME% to '/' */
886 g_strdelimit (g_home_dir, "\\",'/');
889 g_user_name = g_strdup ("somebody");
891 g_real_name = g_strdup ("Unknown");
896 for (p = g_real_name; *p; p++)
900 p = g_strdup (g_real_name);
901 g_free (g_real_name);
909 G_CONST_RETURN gchar*
910 g_get_user_name (void)
912 G_LOCK (g_utils_global);
915 G_UNLOCK (g_utils_global);
920 G_CONST_RETURN gchar*
921 g_get_real_name (void)
923 G_LOCK (g_utils_global);
926 G_UNLOCK (g_utils_global);
931 /* Return the home directory of the user. If there is a HOME
932 * environment variable, its value is returned, otherwise use some
933 * system-dependent way of finding it out. If no home directory can be
934 * deduced, return NULL.
937 G_CONST_RETURN gchar*
938 g_get_home_dir (void)
940 G_LOCK (g_utils_global);
943 G_UNLOCK (g_utils_global);
948 /* Return a directory to be used to store temporary files. This is the
949 * value of the TMPDIR, TMP or TEMP environment variables (they are
950 * checked in that order). If none of those exist, use P_tmpdir from
951 * stdio.h. If that isn't defined, return "/tmp" on POSIXly systems,
952 * and C:\ on Windows.
955 G_CONST_RETURN gchar*
958 G_LOCK (g_utils_global);
961 G_UNLOCK (g_utils_global);
966 G_LOCK_DEFINE (g_prgname);
967 static gchar *g_prgname = NULL;
976 G_UNLOCK (g_prgname);
982 g_set_prgname (const gchar *prgname)
986 g_prgname = g_strdup (prgname);
987 G_UNLOCK (g_prgname);
991 g_direct_hash (gconstpointer v)
993 return GPOINTER_TO_UINT (v);
997 g_direct_equal (gconstpointer v1,
1004 g_int_equal (gconstpointer v1,
1007 return *((const gint*) v1) == *((const gint*) v2);
1011 g_int_hash (gconstpointer v)
1013 return *(const gint*) v;
1017 * g_nullify_pointer:
1018 * @nullify_location: the memory address of the pointer.
1020 * Set the pointer at the specified location to %NULL.
1023 g_nullify_pointer (gpointer *nullify_location)
1025 g_return_if_fail (nullify_location != NULL);
1027 *nullify_location = NULL;
1033 * Get the codeset for the current locale.
1035 * Return value: a newly allocated string containing the name
1036 * of the codeset. This string must be freed with g_free().
1039 g_get_codeset (void)
1042 char *result = nl_langinfo (CODESET);
1043 return g_strdup (result);
1045 #ifdef G_PLATFORM_WIN32
1046 return g_strdup_printf ("CP%d", GetACP ());
1048 /* FIXME: Do something more intelligent based on setlocale (LC_CTYPE, NULL)
1050 return g_strdup ("ISO-8859-1");
1057 #include <libintl.h>
1059 #ifdef G_PLATFORM_WIN32
1061 G_WIN32_DLLMAIN_FOR_DLL_NAME (static, dll_name)
1063 static const gchar *
1064 _glib_get_locale_dir (void)
1066 static const gchar *cache = NULL;
1068 cache = g_win32_get_package_installation_subdirectory
1069 (GETTEXT_PACKAGE, dll_name, "lib\\locale");
1074 #undef GLIB_LOCALE_DIR
1075 #define GLIB_LOCALE_DIR _glib_get_locale_dir ()
1077 #endif /* G_PLATFORM_WIN32 */
1079 G_CONST_RETURN gchar *
1080 _glib_gettext (const gchar *str)
1082 static gboolean _glib_gettext_initialized = FALSE;
1084 if (!_glib_gettext_initialized)
1086 bindtextdomain(GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
1087 _glib_gettext_initialized = TRUE;
1090 return dgettext (GETTEXT_PACKAGE, str);
1093 #endif /* ENABLE_NLS */