1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 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/.
30 #include <glib/gtypes.h>
37 /* On Win32, the canonical directory separator is the backslash, and
38 * the search path separator is the semicolon. Note that also the
39 * (forward) slash works as directory separator.
41 #define G_DIR_SEPARATOR '\\'
42 #define G_DIR_SEPARATOR_S "\\"
43 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR || (c) == '/')
44 #define G_SEARCHPATH_SEPARATOR ';'
45 #define G_SEARCHPATH_SEPARATOR_S ";"
47 #else /* !G_OS_WIN32 */
51 #define G_DIR_SEPARATOR '/'
52 #define G_DIR_SEPARATOR_S "/"
53 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR)
54 #define G_SEARCHPATH_SEPARATOR ':'
55 #define G_SEARCHPATH_SEPARATOR_S ":"
57 #endif /* !G_OS_WIN32 */
59 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
60 * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
62 #if !defined (G_VA_COPY)
63 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
64 # define G_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
65 # elif defined (G_VA_COPY_AS_ARRAY)
66 # define G_VA_COPY(ap1, ap2) g_memmove ((ap1), (ap2), sizeof (va_list))
67 # else /* va_list is a pointer */
68 # define G_VA_COPY(ap1, ap2) ((ap1) = (ap2))
69 # endif /* va_list is a pointer */
70 #endif /* !G_VA_COPY */
72 /* inlining hassle. for compilers that don't allow the `inline' keyword,
73 * mostly because of strict ANSI C compliance or dumbness, we try to fall
74 * back to either `__inline__' or `__inline'.
75 * G_CAN_INLINE is defined in glibconfig.h if the compiler seems to be
76 * actually *capable* to do function inlining, in which case inline
77 * function bodies do make sense. we also define G_INLINE_FUNC to properly
78 * export the function prototypes if no inlining can be performed.
79 * inline function bodies have to be special cased with G_CAN_INLINE and a
80 * .c file specific macro to allow one compiled instance with extern linkage
81 * of the functions by defining G_IMPLEMENT_INLINES and the .c file macro.
83 #if defined (G_HAVE_INLINE) && defined (__GNUC__) && defined (__STRICT_ANSI__)
85 # define inline __inline__
86 #elif !defined (G_HAVE_INLINE)
88 # if defined (G_HAVE___INLINE__)
89 # define inline __inline__
90 # elif defined (G_HAVE___INLINE)
91 # define inline __inline
92 # else /* !inline && !__inline__ && !__inline */
93 # define inline /* don't inline, then */
96 #ifdef G_IMPLEMENT_INLINES
97 # define G_INLINE_FUNC
99 #elif defined (__GNUC__)
100 # define G_INLINE_FUNC extern inline
101 #elif defined (G_CAN_INLINE)
102 # define G_INLINE_FUNC static inline
103 #else /* can't inline */
104 # define G_INLINE_FUNC
105 #endif /* !G_INLINE_FUNC */
107 /* Retrive static string info
110 #define g_get_user_name g_get_user_name_utf8
111 #define g_get_real_name g_get_real_name_utf8
112 #define g_get_home_dir g_get_home_dir_utf8
113 #define g_get_tmp_dir g_get_tmp_dir_utf8
116 G_CONST_RETURN gchar* g_get_user_name (void);
117 G_CONST_RETURN gchar* g_get_real_name (void);
118 G_CONST_RETURN gchar* g_get_home_dir (void);
119 G_CONST_RETURN gchar* g_get_tmp_dir (void);
120 G_CONST_RETURN gchar* g_get_host_name (void);
121 gchar* g_get_prgname (void);
122 void g_set_prgname (const gchar *prgname);
123 G_CONST_RETURN gchar* g_get_application_name (void);
124 void g_set_application_name (const gchar *application_name);
126 G_CONST_RETURN gchar* g_get_user_data_dir (void);
127 G_CONST_RETURN gchar* g_get_user_config_dir (void);
128 G_CONST_RETURN gchar* g_get_user_cache_dir (void);
129 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_data_dirs (void);
132 G_CONST_RETURN gchar* G_CONST_RETURN * g_win32_get_system_data_dirs_for_module (gconstpointer address);
133 static G_CONST_RETURN gchar * G_CONST_RETURN *
134 g_win32_get_system_data_dirs (void)
136 return g_win32_get_system_data_dirs_for_module ((gconstpointer) &g_win32_get_system_data_dirs);
138 #define g_get_system_data_dirs g_win32_get_system_data_dirs
141 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_config_dirs (void);
143 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_language_names (void);
145 typedef struct _GDebugKey GDebugKey;
152 /* Miscellaneous utility functions
154 guint g_parse_debug_string (const gchar *string,
155 const GDebugKey *keys,
158 gint g_snprintf (gchar *string,
161 ...) G_GNUC_PRINTF (3, 4);
162 gint g_vsnprintf (gchar *string,
167 /* Check if a file name is an absolute path */
168 gboolean g_path_is_absolute (const gchar *file_name);
170 /* In case of absolute paths, skip the root part */
171 G_CONST_RETURN gchar* g_path_skip_root (const gchar *file_name);
173 #ifndef G_DISABLE_DEPRECATED
175 /* These two functions are deprecated and will be removed in the next
176 * major release of GLib. Use g_path_get_dirname/g_path_get_basename
177 * instead. Whatch out! The string returned by g_path_get_basename
178 * must be g_freed, while the string returned by g_basename must not.*/
179 G_CONST_RETURN gchar* g_basename (const gchar *file_name);
180 #define g_dirname g_path_get_dirname
182 #endif /* G_DISABLE_DEPRECATED */
185 #define g_get_current_dir g_get_current_dir_utf8
188 /* The returned strings are newly allocated with g_malloc() */
189 gchar* g_get_current_dir (void);
190 gchar* g_path_get_basename (const gchar *file_name) G_GNUC_MALLOC;
191 gchar* g_path_get_dirname (const gchar *file_name) G_GNUC_MALLOC;
193 /* Set the pointer at the specified location to NULL */
194 void g_nullify_pointer (gpointer *nullify_location);
196 /* return the environment string for the variable. The returned memory
197 * must not be freed. */
199 #define g_getenv g_getenv_utf8
200 #define g_setenv g_setenv_utf8
201 #define g_unsetenv g_unsetenv_utf8
202 #define g_find_program_in_path g_find_program_in_path_utf8
205 G_CONST_RETURN gchar* g_getenv (const gchar *variable);
206 gboolean g_setenv (const gchar *variable,
209 void g_unsetenv (const gchar *variable);
210 gchar** g_listenv (void);
212 /* we try to provide a usefull equivalent for ATEXIT if it is
213 * not defined, but use is actually abandoned. people should
214 * use g_atexit() instead.
216 typedef void (*GVoidFunc) (void);
218 # define ATEXIT(proc) g_ATEXIT(proc)
220 # define G_NATIVE_ATEXIT
222 /* we use a GLib function as a replacement for ATEXIT, so
223 * the programmer is not required to check the return value
224 * (if there is any in the implementation) and doesn't encounter
225 * missing include files.
227 void g_atexit (GVoidFunc func);
229 /* Look for an executable in PATH, following execvp() rules */
230 gchar* g_find_program_in_path (const gchar *program);
234 G_INLINE_FUNC gint g_bit_nth_lsf (gulong mask,
236 G_INLINE_FUNC gint g_bit_nth_msf (gulong mask,
238 G_INLINE_FUNC guint g_bit_storage (gulong number);
241 * elements need to be >= sizeof (gpointer)
243 typedef struct _GTrashStack GTrashStack;
249 G_INLINE_FUNC void g_trash_stack_push (GTrashStack **stack_p,
251 G_INLINE_FUNC gpointer g_trash_stack_pop (GTrashStack **stack_p);
252 G_INLINE_FUNC gpointer g_trash_stack_peek (GTrashStack **stack_p);
253 G_INLINE_FUNC guint g_trash_stack_height (GTrashStack **stack_p);
255 /* inline function implementations
257 #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__)
259 g_bit_nth_lsf (gulong mask,
265 if (mask & (1UL << nth_bit))
268 while (nth_bit < ((GLIB_SIZEOF_LONG * 8) - 1));
272 g_bit_nth_msf (gulong mask,
276 nth_bit = GLIB_SIZEOF_LONG * 8;
280 if (mask & (1UL << nth_bit))
287 g_bit_storage (gulong number)
289 register guint n_bits = 0;
300 g_trash_stack_push (GTrashStack **stack_p,
303 GTrashStack *data = (GTrashStack *) data_p;
305 data->next = *stack_p;
308 G_INLINE_FUNC gpointer
309 g_trash_stack_pop (GTrashStack **stack_p)
316 *stack_p = data->next;
317 /* NULLify private pointer here, most platforms store NULL as
325 G_INLINE_FUNC gpointer
326 g_trash_stack_peek (GTrashStack **stack_p)
335 g_trash_stack_height (GTrashStack **stack_p)
340 for (data = *stack_p; data; data = data->next)
345 #endif /* G_CAN_INLINE || __G_UTILS_C__ */
348 * we prefix variable declarations so they can
349 * properly get exported in windows dlls.
351 GLIB_VAR const guint glib_major_version;
352 GLIB_VAR const guint glib_minor_version;
353 GLIB_VAR const guint glib_micro_version;
354 GLIB_VAR const guint glib_interface_age;
355 GLIB_VAR const guint glib_binary_age;
357 const gchar * glib_check_version (guint required_major,
358 guint required_minor,
359 guint required_micro);
361 #define GLIB_CHECK_VERSION(major,minor,micro) \
362 (GLIB_MAJOR_VERSION > (major) || \
363 (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
364 (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \
365 GLIB_MICRO_VERSION >= (micro)))
370 * On Windows, this macro defines a DllMain function that stores the
371 * actual DLL name that the code being compiled will be included in.
372 * STATIC should be empty or 'static'. DLL_NAME is the name of the
373 * (pointer to the) char array where the DLL name will be stored. If
374 * this is used, you must also include <windows.h>. If you need a more complex
375 * DLL entry point function, you cannot use this.
377 * On non-Windows platforms, expands to nothing.
380 #ifndef G_PLATFORM_WIN32
381 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
383 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name) \
384 static char *dll_name; \
387 DllMain (HINSTANCE hinstDLL, \
389 LPVOID lpvReserved) \
391 wchar_t wcbfr[1000]; \
396 case DLL_PROCESS_ATTACH: \
397 if (GetVersion () < 0x80000000) \
399 GetModuleFileNameW ((HMODULE) hinstDLL, wcbfr, G_N_ELEMENTS (wcbfr)); \
400 tem = g_utf16_to_utf8 (wcbfr, -1, NULL, NULL, NULL); \
401 dll_name = g_path_get_basename (tem); \
406 GetModuleFileNameA ((HMODULE) hinstDLL, cpbfr, G_N_ELEMENTS (cpbfr)); \
407 tem = g_locale_to_utf8 (cpbfr, -1, NULL, NULL, NULL); \
408 dll_name = g_path_get_basename (tem); \
416 #endif /* G_PLATFORM_WIN32 */
418 #endif /* __G_UTILS_H__ */