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 native Win32, directory separator is the backslash, and search path
38 * separator is the semicolon.
40 #define G_DIR_SEPARATOR '\\'
41 #define G_DIR_SEPARATOR_S "\\"
42 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR || (c) == '/')
43 #define G_SEARCHPATH_SEPARATOR ';'
44 #define G_SEARCHPATH_SEPARATOR_S ";"
46 #else /* !G_OS_WIN32 */
50 #define G_DIR_SEPARATOR '/'
51 #define G_DIR_SEPARATOR_S "/"
52 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR)
53 #define G_SEARCHPATH_SEPARATOR ':'
54 #define G_SEARCHPATH_SEPARATOR_S ":"
56 #endif /* !G_OS_WIN32 */
58 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
59 * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
61 #if !defined (G_VA_COPY)
62 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
63 # define G_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
64 # elif defined (G_VA_COPY_AS_ARRAY)
65 # define G_VA_COPY(ap1, ap2) g_memmove ((ap1), (ap2), sizeof (va_list))
66 # else /* va_list is a pointer */
67 # define G_VA_COPY(ap1, ap2) ((ap1) = (ap2))
68 # endif /* va_list is a pointer */
69 #endif /* !G_VA_COPY */
71 /* inlining hassle. for compilers that don't allow the `inline' keyword,
72 * mostly because of strict ANSI C compliance or dumbness, we try to fall
73 * back to either `__inline__' or `__inline'.
74 * G_CAN_INLINE is defined in glibconfig.h if the compiler seems to be
75 * actually *capable* to do function inlining, in which case inline
76 * function bodies do make sense. we also define G_INLINE_FUNC to properly
77 * export the function prototypes if no inlining can be performed.
78 * inline function bodies have to be special cased with G_CAN_INLINE and a
79 * .c file specific macro to allow one compiled instance with extern linkage
80 * of the functions by defining G_IMPLEMENT_INLINES and the .c file macro.
82 #if defined (G_HAVE_INLINE) && defined (__GNUC__) && defined (__STRICT_ANSI__)
84 # define inline __inline__
85 #elif !defined (G_HAVE_INLINE)
87 # if defined (G_HAVE___INLINE__)
88 # define inline __inline__
89 # elif defined (G_HAVE___INLINE)
90 # define inline __inline
91 # else /* !inline && !__inline__ && !__inline */
92 # define inline /* don't inline, then */
95 #ifdef G_IMPLEMENT_INLINES
96 # define G_INLINE_FUNC
97 #elif defined (__GNUC__)
98 # define G_INLINE_FUNC extern inline
99 #elif defined (G_CAN_INLINE)
100 # define G_INLINE_FUNC static inline
101 #else /* can't inline */
102 # define G_INLINE_FUNC
103 #endif /* !G_INLINE_FUNC */
105 /* Retrive static string info
108 #define g_get_user_name g_get_user_name_utf8
109 #define g_get_real_name g_get_real_name_utf8
110 #define g_get_home_dir g_get_home_dir_utf8
111 #define g_get_tmp_dir g_get_tmp_dir_utf8
114 G_CONST_RETURN gchar* g_get_user_name (void);
115 G_CONST_RETURN gchar* g_get_real_name (void);
116 G_CONST_RETURN gchar* g_get_home_dir (void);
117 G_CONST_RETURN gchar* g_get_tmp_dir (void);
118 gchar* g_get_prgname (void);
119 void g_set_prgname (const gchar *prgname);
120 G_CONST_RETURN gchar* g_get_application_name (void);
121 void g_set_application_name (const gchar *application_name);
123 G_CONST_RETURN gchar* g_get_user_data_dir (void);
124 G_CONST_RETURN gchar* g_get_user_config_dir (void);
125 G_CONST_RETURN gchar* g_get_user_cache_dir (void);
126 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_data_dirs (void);
127 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_config_dirs (void);
129 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_language_names (void);
131 typedef struct _GDebugKey GDebugKey;
138 /* Miscellaneous utility functions
140 guint g_parse_debug_string (const gchar *string,
141 const GDebugKey *keys,
144 gint g_snprintf (gchar *string,
147 ...) G_GNUC_PRINTF (3, 4);
148 gint g_vsnprintf (gchar *string,
153 /* Check if a file name is an absolute path */
154 gboolean g_path_is_absolute (const gchar *file_name);
156 /* In case of absolute paths, skip the root part */
157 G_CONST_RETURN gchar* g_path_skip_root (const gchar *file_name);
159 #ifndef G_DISABLE_DEPRECATED
161 /* These two functions are deprecated and will be removed in the next
162 * major release of GLib. Use g_path_get_dirname/g_path_get_basename
163 * instead. Whatch out! The string returned by g_path_get_basename
164 * must be g_freed, while the string returned by g_basename must not.*/
165 G_CONST_RETURN gchar* g_basename (const gchar *file_name);
166 #define g_dirname g_path_get_dirname
168 #endif /* G_DISABLE_DEPRECATED */
171 #define g_get_current_dir g_get_current_dir_utf8
174 /* The returned strings are newly allocated with g_malloc() */
175 gchar* g_get_current_dir (void);
176 gchar* g_path_get_basename (const gchar *file_name) G_GNUC_MALLOC;
177 gchar* g_path_get_dirname (const gchar *file_name) G_GNUC_MALLOC;
179 /* Set the pointer at the specified location to NULL */
180 void g_nullify_pointer (gpointer *nullify_location);
182 /* return the environment string for the variable. The returned memory
183 * must not be freed. */
185 #define g_getenv g_getenv_utf8
186 #define g_setenv g_setenv_utf8
187 #define g_unsetenv g_unsetenv_utf8
188 #define g_find_program_in_path g_find_program_in_path_utf8
191 G_CONST_RETURN gchar* g_getenv (const gchar *variable);
192 gboolean g_setenv (const gchar *variable,
195 void g_unsetenv (const gchar *variable);
196 gchar** g_listenv (void);
198 /* we try to provide a usefull equivalent for ATEXIT if it is
199 * not defined, but use is actually abandoned. people should
200 * use g_atexit() instead.
202 typedef void (*GVoidFunc) (void);
204 # define ATEXIT(proc) g_ATEXIT(proc)
206 # define G_NATIVE_ATEXIT
208 /* we use a GLib function as a replacement for ATEXIT, so
209 * the programmer is not required to check the return value
210 * (if there is any in the implementation) and doesn't encounter
211 * missing include files.
213 void g_atexit (GVoidFunc func);
215 /* Look for an executable in PATH, following execvp() rules */
216 gchar* g_find_program_in_path (const gchar *program);
220 G_INLINE_FUNC gint g_bit_nth_lsf (gulong mask,
222 G_INLINE_FUNC gint g_bit_nth_msf (gulong mask,
224 G_INLINE_FUNC guint g_bit_storage (gulong number);
227 * elements need to be >= sizeof (gpointer)
229 typedef struct _GTrashStack GTrashStack;
235 G_INLINE_FUNC void g_trash_stack_push (GTrashStack **stack_p,
237 G_INLINE_FUNC gpointer g_trash_stack_pop (GTrashStack **stack_p);
238 G_INLINE_FUNC gpointer g_trash_stack_peek (GTrashStack **stack_p);
239 G_INLINE_FUNC guint g_trash_stack_height (GTrashStack **stack_p);
241 /* inline function implementations
243 #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__)
245 g_bit_nth_lsf (gulong mask,
251 if (mask & (1UL << nth_bit))
254 while (nth_bit < ((GLIB_SIZEOF_LONG * 8) - 1));
258 g_bit_nth_msf (gulong mask,
262 nth_bit = GLIB_SIZEOF_LONG * 8;
266 if (mask & (1UL << nth_bit))
273 g_bit_storage (gulong number)
275 register guint n_bits = 0;
286 g_trash_stack_push (GTrashStack **stack_p,
289 GTrashStack *data = (GTrashStack *) data_p;
291 data->next = *stack_p;
294 G_INLINE_FUNC gpointer
295 g_trash_stack_pop (GTrashStack **stack_p)
302 *stack_p = data->next;
303 /* NULLify private pointer here, most platforms store NULL as
311 G_INLINE_FUNC gpointer
312 g_trash_stack_peek (GTrashStack **stack_p)
321 g_trash_stack_height (GTrashStack **stack_p)
326 for (data = *stack_p; data; data = data->next)
331 #endif /* G_CAN_INLINE || __G_UTILS_C__ */
334 * we prefix variable declarations so they can
335 * properly get exported in windows dlls.
337 GLIB_VAR const guint glib_major_version;
338 GLIB_VAR const guint glib_minor_version;
339 GLIB_VAR const guint glib_micro_version;
340 GLIB_VAR const guint glib_interface_age;
341 GLIB_VAR const guint glib_binary_age;
343 const gchar * glib_check_version (guint required_major,
344 guint required_minor,
345 guint required_micro);
347 #define GLIB_CHECK_VERSION(major,minor,micro) \
348 (GLIB_MAJOR_VERSION > (major) || \
349 (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
350 (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \
351 GLIB_MICRO_VERSION >= (micro)))
356 * On Windows, this macro defines a DllMain function that stores the
357 * actual DLL name that the code being compiled will be included in.
358 * STATIC should be empty or 'static'. DLL_NAME is the name of the
359 * (pointer to the) char array where the DLL name will be stored. If
360 * this is used, you must also include <windows.h>. If you need a more complex
361 * DLL entry point function, you cannot use this.
363 * On non-Windows platforms, expands to nothing.
366 #ifndef G_PLATFORM_WIN32
367 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
369 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name) \
370 static char *dll_name; \
373 DllMain (HINSTANCE hinstDLL, \
375 LPVOID lpvReserved) \
380 case DLL_PROCESS_ATTACH: \
381 GetModuleFileName ((HMODULE) hinstDLL, bfr, sizeof (bfr)); \
382 dll_name = g_path_get_basename (bfr); \
388 #endif /* G_PLATFORM_WIN32 */
390 #endif /* __G_UTILS_H__ */